Replacing all existing KEY 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 2535 for more information about KEY records.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/KEYRecord/ PUT — Replace all existing KEY Records on the zone/node indicated.
HTTP Action — PUT
URI — https://api.dynect.net/REST/KEYRecord/<zone>/<fqdn>/ |
Arguments — Click for More Info
- array
KEYRecords — Required. Individual records.
- hash
rdata — Required. RData defining the record to update.
- string
algorithm — Required. Numeric identifier for algorithm used.
1 = RSA/MD5 (recommended)
2 = Diffie-Hellman (Optional, key only)
3 = DSA (mandatory)
- string
flags — Required. See RFC 2535 for information on KEY record flags.
- string
protocol — Required. Numeric identifier of the protocol for this KEY record.
1 = TLS
2 = Email
3 = DNSSEC
4 = IPsec
- string
public_key — Required. The public key for this record.
- string
ttl — TTL for the record in seconds. 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 — Numeric identifier for algorithm used.
- string
flags — See RFC 2535 for information on KEY record flags.
- string
protocol — Numeric identifier of the protocol for this KEY record.
- string
public_key — The public key for this record.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
|
SOAP Syntax
Click to view all SOAP Commands |
ReplaceKEYRecords — Replace all existing KEY Record on the zone/node indicated. |
Arguments — Click for More Info
- array
KEYRecords — Required. Individual records.
- string
fqdn — Required. Name of node where the record will be updating.
- hash
rdata — Required. RData defining the record to update.
- string
algorithm — Required. Numeric identifier for algorithm used.
1 = RSA/MD5 (recommended)
2 = Diffie-Hellman (Optional, key only)
3 = DSA (mandatory)
- string
flags — Required. See RFC 2535 for information on KEY record flags.
- string
protocol — Required. Numeric identifier of the protocol for this KEY record.
1 = TLS
2 = Email
3 = DNSSEC
4 = IPsec
- string
public_key — Required. The public key for this record.
- string
ttl — TTL for the record in seconds. Set to “0” to use zone default.
- string
zone — Required. Name of zone where the record will be updated.
- string
token — Required. The session identifier.
|
Response — 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 — Numeric identifier for algorithm used.
- string
flags — See RFC 2535 for information on KEY record flags.
- string
protocol — Numeric identifier of the protocol for this KEY record.
- string
public_key — Required. The public key for this 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 — Click for More Info
{
'KEYRecords' => [
{
'fqdn' => 'www.example.com',
'rdata' => {
'flags' => '257',
'algorithm' => '5',
'protocol' => '3',
'public_key' => 'AQPWA4BRyjB3eqYNy/oykeGcSXjl+HQK9CciAxJfMcS1vEuwz9c+QG7sEJnQuH5B9i5o/ja+DVitY3jpXNa12mEn',
},
'ttl' => '3600',
'zone' => 'example.com',
},
{
'fqdn' => 'www.example.com',
'rdata' => {
'flags' => '257',
'algorithm' => '5',
'protocol' => '3',
'public_key' => 'AQPWA4BRyjB3eqYNy/oykeGcSXjl+HQK9CciAxJfMcS1vEuwz9c+QG7sEJnQuH5B9i5o/ja+DVitY3jpXNa12mEn',
},
'ttl' => '3600',
'zone' => 'example.com',
}
],
'token' => 'asdlkfjasl23j4879afa',
}
|
DNS API Knowledge Base