Retrieving DNAME 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 2672 for more information about the DNAME Record.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/DNAMERecord/ GET — Retrieve the DNAME Records from the zone/node indicated.
HTTP Action — GET
URIs:
Retrieve One DNAME Record — https://api.dynect.net/REST/DNAMERecord/<zone>/<fqdn>/<record_id>/
Retrieve DNAME Records — https://api.dynect.net/REST/DNAMERecord/<zone>/<fqdn>/ |
Arguments:
No Arguments |
Response:
Retrieve one DNAME Record — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record.
- string
dname — Target hostname.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
Retrieve DNAME Records: array — Individual DNAME record resources. |
SOAP Syntax
Click to view all SOAP Commands |
GetOneDNAMERecord — Retrieve the specified DNAME Record from the zone/node indicated.
GetDNAMERecords — Retrieve the DNAME Records from the zone/node indicated. |
Arguments:
GetOneDNAMERecord — Click for More Info
- string
fqdn — Required. Name of node where the record will be added.
- string
record_id — Required if there is more than one record of this type at the zone/node.
- hash
rdata — RData defining the record to add.
- string
dname — Required. Target hostname.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where the record will be added.
GetDNAMERecords:
- string
fqdn — Required. Name of node where the record will be added.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where the record will be added.
|
Response:
GetOneDNAMERecord — 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
dname — Target hostname.
- string
record_id — A numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
GetDNAMERecords — 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
dname — Target hostname.
- string
record_id — A numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
|
Example Request (GetOneDNAMERecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'dname' => 'target.example.com.'
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetDNAMERecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base