Replacing all child Delegation Signer (CDS) 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 7344 for more information about DS records.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/CDSRecord/ PUT — Replaces all existing CDS record on the designated node. NOTE: CDS records MUST be at the child zone apex.
HTTP Action — PUT
URI — https://api.dynect.net/REST/CDSRecord/<zone>/<fqdn>/ |
Arguments — Click for More Info
- array
CDSRecords — Required.
- hash
rdata — Required. RData defining the record to update.
- 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 child 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
|
Response — Click for More Info
- array — Individual Records
- 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 child 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.
|
SOAP Syntax
Click to view all SOAP Commands |
ReplaceCDSRecord — Replaces all existing CDS record at the zone/node indicated. NOTE: CDS records MUST be at the child zone apex. |
Arguments — Click for More Info
- array
CDSRecords — Required.
- string
fqdn — Required. Name of node where the record exists.
- hash
rdata — Required. RData defining the record to update.
- 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 child 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
zone — Required. Name of the zone where the record exists.
- string
token — Required. The session identifier.
|
Response — 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 child 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 — Click for More Info
{
'CDSRecords' => [
{
'fqdn' => 'www.example.com',
'rdata' => {
'algorithm' => '5',
'digest' => '6FCDE3485723A126AC53919A47183E529F559473',
'digtype' => '1',
'keytag' => '36211',
},
'ttl' => '3600',
'zone' => 'example.com',
},
{
'fqdn' => 'www.example.com',
'rdata' => {
'algorithm' => '5',
'digest' => '7FCDE3485723A126AC53919A47183E529F559473',
'digtype' => '1',
'keytag' => '36212',
},
'ttl' => '3600',
'zone' => 'example.com',
}
],
'token' => 'asdlkfjasl23j4879afa',
}
|
<< DNS API Knowledge Base