Understanding How The API Works »
Creating KX 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 2230 for more information about KX records.
REST Syntax
Click to view all REST Resources |
/REST/KXRecord/ POST — Create a new KX Record on the zone/node indicated.
HTTP Action — POST
URI — https://api.dynect.net/REST/KXRecord/<zone>/<fqdn>/ |
Arguments — Click for More Info
- hash
rdata — Required. RData defining the record to add.
- string
exchange — Required. Hostname that will act as the Key Exchanger. The hostname must have a CNAME record, an A Record and/or an AAAA record associated with it.
- string
preference — Required. Numeric value for priority usage. Lower value takes precedence over higher value where two records of the same type exist on the zone/node.
- string
ttl — TTL for the record in seconds. Set to “0” to use zone default.
|
Response — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record to add.
- string
exchange — Hostname that will act as the Key Exchanger.
- string
preference — Numeric value for priority usage. Lower value takes precedence over higher value where two records of the same type exist on the zone/node.
- 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 |
CreateKXRecord — Create a new KX Record on the zone/node indicated. |
Arguments — Click for More Info
- string
fqdn — Required. Name of node where the record will be added.
- hash
rdata — Required. RData defining the record to add.
- string
exchange — Required. Hostname that will act as the Key Exchanger. The hostname must have a CNAME record, an A Record and/or an AAAA record associated with it.
- string
preference — Required. Numeric value for priority usage. Lower value takes precedence over higher value where two records of the same type exist on the zone/node.
- string
token — Required. The session identifier.
- 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 added.
|
Response — 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
exchange — Hostname that will act as the Key Exchanger.
- string
preference — Numeric value for priority usage. Lower value takes precedence over higher value where two records of the same type exist on the zone/node.
- 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
{
'fqdn' => 'www.example.com',
'rdata' => {
'preference' => '10',
'exchange' => 'kx1.example.net',
},
'token' => 'asdlkfjasl23j4879afa',
'ttl' => '3600',
'zone' => 'example.com',
}
|
<< DNS API Knowledge Base