Retrieving one or more DNSKEY 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 DNSKEY record.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/DNSKEYRecord/ GET — Retrieve one or all existing DNSKEY Record on the zone/node indicated.
HTTP Action — GET
URIs:
Get one DNSKEY Record — https://api.dynect.net/REST/DNSKEYRecord/<zone>/<fqdn>/<record_id>/
Get DNSKEY Records — https://api.dynect.net/REST/DNSKEYRecord/<zone>/<fqdn>/ |
Arguments:
No Arguments. |
Response:
Get one DNSKEY Record — Click for More Info
- string
fqdn — Name of node where the record resides.
- hash
rdata — RData defining the record.
- string
algorithm — Public key encryption algorithm will sign the zone. Default value = RSA/SHA-1 .
- string
flags — Numeric value confirming this is the zone’s DNSKEY. Default value = 256.
- string
protocol — Numeric value for protocol. Set to 3 for DNSSEC.
- string
public_key — The public key for the DNSSEC signed zone.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of zone where the record resides.
Get DNSKEY Records: array — Individual DNSKEY records. |
SOAP Syntax
Click to view all SOAP Commands |
GetOneDNSKEYRecord — Retrieve the specified DNSKEY Record on the zone/node indicated.
GetDNSKEYRecords — Retrieve all DNSKEY Records on the zone/node indicated. |
Arguments:
GetOneDNSKEYRecord — Click for More Info
- string
fqdn — Required. Name of node where the record resides.
- string
record_id — If specified, the ID of the record to find.
- hash
rdata — Required. RData defining the record.
- string
algorithm — Required. Public key encryption algorithm will sign the zone. Default value = RSA/SHA-1 .
- string
flags — Required. Numeric value confirming this is the zone’s DNSKEY. Default value = 256.
- string
protocol — Required. Numeric value for protocol. Set to 3 for DNSSEC.
- string
public_key — Required. The public key for the DNSSEC signed zone.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where the record resides.
GetDNSKEYRecords — Click for More Info
string fqdn — Required. Name of node where the record resides.
string token — Required. The session identifier.
string zone — Required. Name of zone where the record resides.
|
Response:
GetOneDNSKEYRecord — 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
algorithm — Public key encryption algorithm will sign the zone. Default value = RSA/SHA-1.
- string
flags — Numeric value confirming this is the zone’s DNSKEY. Default value = 256.
- string
protocol — Numeric value for protocol. Set to 3 for DNSSEC.
- string
public_key — The public key for the DNSSEC signed zone.
- 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.
GetDNSKEYRecords — 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
algorithm — Public key encryption algorithm will sign the zone. Default value = RSA/SHA-1.
- string
flags — Numeric value confirming this is the zone’s DNSKEY. Default value = 256.
- string
protocol — Numeric value for protocol. Set to 3 for DNSSEC.
- string
public_key — The public key for the DNSSEC signed zone.
- 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 (GetOneDNSKEYRecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'flags' => '257',
'algorithm' => '5',
'protocol' => '3',
'public_key' => 'AQPWA4BRyjB3eqYNy/oykeGcSXjl+HQK9CciAxJfMcS1vEuwz9c+QG7sEJnQuH5B9i5o/ja+DVitY3jpXNa12mEn',
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetDNSKEYRecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base