Retrieving all DHCID Records on a zone/node 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 4701 for more information about the DHCID record.
Understanding How The API Works »
REST Syntax
| Click to view all REST Resources |
| /REST/DHCIDRecord/ GET — Retrieve existing DHCID Records on the zone/node indicated.HTTP Action — GETURIs:
Retrieve one record — https://api.dynect.net/REST/DHCIDRecord/<zone>/<fqdn>/<record_id>/
Retrieve all records — https://api.dynect.net/REST/DHCIDRecord/<zone>/<fqdn>/ |
| Arguments:
No Arguments. |
Response:Retrieve one DHCID Record — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata— RData defining the record.
- string
digest — Base-64 encoded digest of DHCP data.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
Retrieve all DHCID Records: array — Individual records. |
SOAP Syntax
| Click to view all SOAP Commands |
| GetOneDHCIDRecord — Retrieve the specified DHCID Record on the zone/node indicated.
GetDHCIDRecords — Retrieve all existing DHCID Records on the zone/node indicated. |
| Arguments:
GetOneDHCIDRecord — Click for More Info
- string
fqdn — Required. Name of node where the record will be added.
- string
record_id — Indicates the record to retrieve from the zone/node.
- hash
rdata— RData defining the record to retrieve.
- string
digest — Required. Base-64 encoded digest of DHCP data.
- string
token — Required. The session identifier.
- zone — Required. Name of zone where the record will be added.
GetDHCIDRecords:
- 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:
GetOneDHCIDRecord — 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
digest — Base-64 encoded digest of DHCP data.
- 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.
GetDHCIDRecords — 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
digest — Base-64 encoded digest of DHCP data.
- 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(GetOneDHCIDRecord) — Click for More Info
{
'fqdn' => 'client.example.com',
'rdata' => {
'digest' => 'AAIBY2/AuCccgoJbsaxcQc9TUapptP69lOjxfNuVAA2kjEA='
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'client' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request(GetDHCIDRecords) — Click for More Info
{
'fqdn' => 'client.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base
