Retrieving one or all Dynamic DNS service instances in 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 |
/REST/DDNS/ GET — Retrieves one or all Dynamic DNS service on the zone/node indicated.
HTTP Action — GET
URIs:
Get one DDNS — https://api.dynect.net/REST/DDNS/<zone>/<fqdn>/<record_type>/
Get all DDNS — https://api.dynect.net/REST/DDNS/<zone>/
|
Arguments:
Get one DDNS — No Arguments.
Get all DDNS:
- string
detail — A boolean indicating whether or not to return the full details or a list of service resources.
Valid values:
Y – The details of each service are specified.
N – The list of service resources is returned. Default.
|
Response:
Get one DDNS — Click for More Info
- string
abuse_count — Total number of abusive updates since last good update.
- string
active — A boolean indicating whether or not the service is active.
Y – The service is active.
N – The service is inactive.
- string
last_updated — Timestamp of the last good update by an update client.
- string
address — IPv4 or IPv6 Address.
- string
fqdn — Fully qualified domain name of a node in the zone
- string
record_type — The RRType of the service.
Valid values: A or AAAA
- string
zone — Name of the zone.
Get all DDNS: array — Individual DDNS service resources.
|
SOAP Syntax
Click to view all SOAP Commands |
GetOneDDNS — Retrieve a specific Dynamic DNS service.
GetDDNSs — Retrieve all Dynamic DNS services.
|
Arguments:
GetOneDDNS — Click for More Info
string fqdn — Required. Name of node where the service will exist.
string record_type — Required. The ID of the A or AAAA record where the service will be added.
string token — Required. The session identifier.
string zone — Required. Name of zone where the service will exist.
GetDDNSs — Click for More Info
string token — Required. The session identifier.
string zone — Required. Name of zone where the service will exist.
|
Response:
GetOneDDNS — Click for More Info
- hash
data
- string
abuse_count — Total number of abusive updates since last good update.
- string
active — A boolean indicating whether or not the service is active.
Y – The service is active.
N – The service is inactive.
- string
last_updated — Timestamp of the last good update by an update client.
- string
address — IPv4 or IPv6 Address.
- string
fqdn — Fully qualified domain name of a node in the zone
- string
record_type — The RRType of the service.
Valid values: A or AAAA
- string
zone — Name of the zone.
GetDDNSs — Click for More Info
- array
data
- string
abuse_count — Total number of abusive updates since last good update.
- string
active — A boolean indicating whether or not the service is active.
Y – The service is active.
N – The service is inactive.
- string
last_updated — Timestamp of the last good update by an update client.
- string
address — IPv4 or IPv6 Address.
- string
fqdn — Fully qualified domain name of a node in the zone
- string
record_type — The RRType of the service.
Valid values: A or AAAA
- string
zone — Name of the zone.
|
Example Request (GetOneDDNS): Click for More Info
{
'fqdn' => 'www.example.com',
'record_type' => 'A',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetDDNSs): Click for More Info
{
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base