Retrieving one or all existing SOA Records using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
See RFC 1035 for more information about SOA records.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/SOARecord/ GET — Retrieve one or all existing SOA Records on the zone/node indicated.
HTTP Action — GET
URIs:
Get one SOA record — https://api.dynect.net/REST/SOARecord/<zone>/<fqdn>/<record_id>/
Get all SOA records — https://api.dynect.net/REST/SOARecord/<zone>/<fqdn>/ |
Arguments:
No Arguments. |
Response:
Get one SOA record — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record(s) to replace.
- string
rname — Domain name specifying the mailbox of the person responsible for this zone.
- string
record_type — The RRType of the record.
- string
serial_style — The style in which serial numbers will be generated for this zone. One of the following styles: increment, epoch, day, or minute.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
Get all SOA records — array — Individual SOA Record resources. |
SOAP Syntax
Click to view all SOAP Commands |
GETOneSOARecord — Retrieve one existing SOA Record on the zone/node indicated.
GETSOARecords — Retrieve all existing SOA Records on the zone/node indicated. |
Arguments:
GetOneSOARecord — Click for More Info
- string
fqdn — Required. Fully qualified domain name of a node in the zone.
- string
record_id — A numeric identifier for the record.
- hash
rdata — RData defining the record.
- string
expire — Required. The maximum amount of time before the zone is no longer authoritative.
- string
minimum — Required. The minimum TTL (time to live) value that should be sent with any record in this zone.
- string
mname — Required. Domain name of the name server that was the primary source of data for this zone.
- string
refresh — Required. Time intervals between refreshing the zone.
- string
retry — Required. Time intervals between retries of a failed refresh of the zone.
- string
rname — Required. Domain name specifying the mailbox of the person responsible for this zone.
- string
serial — Required. Unsigned 32-bit version number of the original copy of the zone. Zone transfers preserve this value.
- string
token — Required. The session identifier.
- string
zone — Name of the zone.
GetSOARecords — Click for More Info
- string
fqdn — Required. Name of node where the record exists.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where the record exists.
|
Response:
GetOneSOARecord — Click for More Info
- hash
data
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record.
- string
expire — The maximum amount of time before the zone is no longer authoritative.
- string
minimum — The minimum TTL (time to live) value that should be sent with any record in this zone.
- string
mname — Domain name of the name server that was the primary source of data for this zone.
- string
refresh — Time intervals between refreshing the zone.
- string
retry — Time intervals between retries of a failed refresh of the zone.
- string
rname — Domain name specifying the mailbox of the person responsible for this zone.
- string
serial — Unsigned 32-bit version number of the original copy of the zone. Zone transfers preserve this value.
- string
record_id — A numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
serial_style — The style in which serial numbers will be generated for this zone. One of the following styles: increment, epoch, day, or minute.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
GetSOARecords — Click for More Info
- array
data
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record.
- string
expire — The maximum amount of time before the zone is no longer authoritative.
- string
minimum — The minimum TTL (time to live) value that should be sent with any record in this zone.
- string
mname — Domain name of the name server that was the primary source of data for this zone.
- string
refresh — Time intervals between refreshing the zone.
- string
retry — Time intervals between retries of a failed refresh of the zone.
- string
rname — Domain name specifying the mailbox of the person responsible for this zone.
- string
serial — Unsigned 32-bit version number of the original copy of the zone. Zone transfers preserve this value.
- string
record_id — A numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
serial_style — The style in which serial numbers will be generated for this zone. One of the following styles: increment, epoch, day, or minute.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
|
Example Request (GetOneSOARecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'refresh' => '3600',
'retry' => '300',
'expire' => '604800',
'minimum' => '60',
'mname' => 'ns1.example.com',
'rname' => 'admin.example.com',
'serial' => 32,
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetSOARecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base