Retrieving one or more existing ALIAS 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.
Understanding How The API Works »
REST Syntax
| Click to view all REST Resources |
| /REST/ALIASRecord/ GET — Retrieve one or more existing ALIAS Record on the zone/node indicated.
NOTE: If you choose to point your ALIAS record at an asset managed by your Dyn Managed DNS account, you may see higher than expected QPS.
HTTP Action — GET
URIs:
Get One Record — https://api.dynect.net/REST/ALIASRecord/<zone>/<fqdn>/<record_id>/
Get All Records — https://api.dynect.net/REST/ALIASRecord/<zone>/<fqdn>/ |
| Arguments:
No Arguments. |
| Response:
Get One ALIAS Record — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
Get All ALIAS Records: array — Individual ALIAS record resources. |
SOAP Syntax
| Click to view all SOAP Commands |
| GetOneALIASRecord — Get an existing ALIAS Record on the zone/node indicated.
GetALIASRecords — Get all existing ALIAS Records on the zone/node indicated.
NOTE: If you choose to point your ALIAS record at an asset managed by your Dyn Managed DNS account, you may see higher than expected QPS. |
| Arguments:
GetOneALIASRecord — Click for More Info
- string
fqdn — Required. Name of node where the record exists.
- string
record_id — The ID of the specific record to retrieve, use if there is more than one possible record.
NOTE: Use either record_id or rdata and alias to identify the ALIAS record to retrieve.
- hash
rdata — RData defining the record to retrieve.
- string
alias — Required if using rdata field. Hostname.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where the record exists.
GetALIASRecords — Click for More Info
string fqdn — Required. Name of node where the records exist.
string token — Required. The session identifier.
string zone — Required. Name of zone where the records exist.
|
| Response:
GetOneALIASRecord — 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
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.
GetALIASRecords — 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
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(GetOneALIASRecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'alias' => 'example.net',
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request(GetALIASRecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base
