Retrieving secondary zone information 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.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
Secondary/ GET — Retrieves information on one or all secondary zones.
HTTP Action — GET
URI(s):
Retrieve one Secondary Zone — https://api.dynect.net/REST/Secondary/<zone>/
Retrieve all Secondary Zones — https://api.dynect.net/REST/Secondary |
Arguments:
No Arguments. |
Response:
One Secondary Zone — Click for More Info
- string
active — State of the secondary service.
Valid values:
Y = service is active
N = service is inactive
L = service is loading
- string
contact_nickname — Contact that receives notifications for this zone.
- array
masters — A list of IPv4 or IPv6 addresses of the master nameservers for this zone.
- string
tsig_key_name — Name of the TSIG key that will be used to sign transfer requests to your zone’s master.
- string
zone — Name of the zone.
All Secondary Zones — array of Secondary zone resources |
SOAP Syntax
Click to view all SOAP Commands |
GetOneSecondary — Retrieves information on one secondary zone.
GetSecondaries — Retrieves information on all existing secondary zones. |
Arguments:
GetOneSecondary:
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone to get information about.
GetSecondaries:
- string
token — Required. The session identifier.
|
Response:
GetOneSecondary — Click for More Info
- hash
data
- string
active — State of the secondary service.
Valid values:
Y = service is active
N = servie is inactive
L = service is loading
- string
contact_nickname — Contact that receives notifications for this zone.
- array
masters — A list of IPv4 or IPv6 addresses of the master nameservers for this zone.
- string
tsig_key_name — Name of the TSIG key that will be used to sign transfer requests to your zone’s master.
- string
zone — Name of the zone.
GetSecondaries — Click for More Info
- array
data
- string
active — State of the secondary service.
Valid values:
Y = service is active
N = service is inactive
L = service is loading
- string
contact_nickname — Contact that receives notifications for this zone.
- array
masters — A list of the IPv4 or IPv6 addresses of the master nameservers for this zone.
- string
zone — Name of zone.
|
Example Request (GetOneSecondary) — Click for More Info
{
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetSecondaries) — Click for More Info
{
'token' => 'asdlkfjasl23j4879afa',
}
|
DNS API Knowledge Base