zone_soas

Creates, updates, deletes, gets or lists a zone_soas resource.

Overview

Name	zone_soas
Type	Resource
Id	ovh.domain.zone_soas

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
email	string	Email address of the DNS Administrator
expire	integer	When a zone transfer fails, a countdown clock begins. When the number of seconds set in the expire field elapses, the nameserver stops answering for that zone file
nx_domain_ttl	integer	Non-Existent Domain TTL, if the name server returns a negative response, the remote server should wait the number of seconds set in the nxDomainTtl field before trying again (wire: nxDomainTtl)
refresh	integer	The refresh value determines the interval in seconds between successful zone transfers of the entire zone file from a nameserver to another.
serial	integer	The serial number is used to indicate which copy of the zone file is the most current. When editing zone files, you must increment the serial number
server	string	Primary authoritative server
ttl	integer	Time To Live in seconds

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_name		Returns the SOA of the zone: primary server, administrator email, serial, refresh, expire, TTL and negative-response TTL.
update	update	zone_name		Updates the SOA values of the zone.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
zone_name	string	Zone name (wire: zoneName)

SELECT examples

get

Returns the SOA of the zone: primary server, administrator email, serial, refresh, expire, TTL and negative-response TTL.

SELECT
email,
expire,
nx_domain_ttl,
refresh,
serial,
server,
ttl
FROM ovh.domain.zone_soas
WHERE zone_name = '{{ zone_name }}' -- required
;

UPDATE examples

update

Updates the SOA values of the zone.

UPDATE ovh.domain.zone_soas
SET 
email = '{{ email }}',
expire = {{ expire }},
nx_domain_ttl = {{ nx_domain_ttl }},
refresh = {{ refresh }},
serial = {{ serial }},
server = '{{ server }}',
ttl = {{ ttl }}
WHERE 
zone_name = '{{ zone_name }}' --required;