Retrieving one or all Delegation Signer (DS) 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 4034 for more information about the DS record.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/DSRecord/ GET — Retrieves one or all existing DS record on the designated node.
HTTP Action — GET
URIs:
Get one DS record — https://api.dynect.net/REST/DSRecord/<zone>/<fqdn>/<record_id>/
Get DS records — https://api.dynect.net/REST/DSRecord/<zone>/<fqdn>/ |
Arguments:
No Arguments. |
Response:
Get one DS record — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record to update.
- string
algorithm — Identifies the encoding algorithm.
- string
digest — 20-byte, hexadecimal-encoded, one-way hash of the DNSKEY record.
- string
digtype — Identifies which digest mechanism to use to verify the digest.
- string
keytag — Identifies which digest mechanism to use to verify the digest.
- string
record_type — The RRType of the record.
- string
ttl TTL for the record. Set to “0” to use zone default.
- string
zone — Name of the zone.
Get DS records: array — Individual DS records |
SOAP Syntax
Click to view all SOAP Commands |
GetOneDSRecord — Retrieves one existing DS record at the zone/node indicated.
GetDSRecords — Retrieves all existing DS records. |
Arguments:
GetOneDSRecord — Click for More Info
- string
fqdn — Required. Name of node where the record exists.
- string
record_id — Required only if there is more than one DS record.
- hash
rdata — If specified, the RData defining the record to retrieve.
- string
algorithm — Required. Identifies the encoding algorithm.
Valid values:
1 — RSA/MD5
2 — Diffie-Hellman
3 — DSA/SHA1
4 — Elliptic Curve
5 — RSA/SHA1 ** Use this value unless otherwise directed.
252 — Indirect Key
253 — Private – Domain Name
254 — Private – OID
- string
digest — Required. The digest in hexadecimal form. 20-byte, hexadecimal-encoded, one-way hash of the DNSKEY record surrounded by parenthesis characters ‘(‘ & ‘)’.
- string
digtype — Required. Identifies which digest mechanism to use to verify the digest.
Valid values:
1 — SHA1 ** Use this value unless otherwise directed.
2 — SHA256
- string
keytag — Required. Identifies which digest mechanism to use to verify the digest.
- string
ttl TTL for the record. Set to “0” to use zone default.
- string
token — Required. The session identifier.
- string
zone — Required. Name of the zone where the record exists.
GetDSRecords:
- string
fqdn — Required. Name of node where the record exists.
- string
token — Required. The session identifier.
- string
zone — Required. Name of the zone where the record exists.
|
Response:
GetOneDSRecord — Click for More Info
- hash
data
- string
fqdn — Name of node where the record exists.
- hash
rdata — RData defining the record to update.
- string
algorithm — Identifies the encoding algorithm.
- string
digest — 20-byte, hexadecimal-encoded, one-way hash of the DNSKEY record.
- string
digtype — Identifies which digest mechanism to use to verify the digest.
- string
keytag — Identifies which digest mechanism to use to verify the digest.
- string
record_id — Numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
ttl TTL for the record. Set to “0” to use zone default.
- string
zone — Name of the zone where the record exists.
GetDSRecords — Click for More Info
- array
data
- string
fqdn — Name of node where the record exists.
- hash
rdata — RData defining the record to update.
- string
algorithm — Identifies the encoding algorithm.
- string
digest — 20-byte, hexadecimal-encoded, one-way hash of the DNSKEY record.
- string
digtype — Identifies which digest mechanism to use to verify the digest.
- string
keytag — Identifies which digest mechanism to use to verify the digest.
- string
record_id — Numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
ttl TTL for the record. Set to “0” to use zone default.
- string
zone — Name of the zone where the record exists.
|
Example Request (GetOneDSRecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'algorithm' => '5',
'digest' => '6FCDE3485723A126AC53919A47183E529F559473',
'digtype' => '1',
'keytag' => '36211',
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetDSRecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base