Retrieving existing 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.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/KXRecord/ GET — Retrieve one or all existing KX Records on the zone/node indicated.
HTTP Action — GET
URIs:
Get one KX Record — https://api.dynect.net/REST/KXRecord/<zone>/<fqdn>/<record_id>/
Get KX Records — https://api.dynect.net/REST/KXRecord/<zone>/<fqdn>/ |
Arguments:
No Arguments. |
Response:
One KX Record — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record to retrieve.
- 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.
Get KX Records: array — Individual records. |
SOAP Syntax
Click to view all SOAP Commands |
GetOneKXRecord — Retrieve one existing KX Record on the zone/node indicated.
GetKXRecords — Retrieve all existing KX Records on the zone/node indicated. |
Arguments:
GetOneKXRecord — Click for More Info
- string
fqdn — Required. Name of node where the record will be updating.
- string
record_id — ID of the record to find. Optional.
- hash
rdata — Required. RData defining the record to update.
- 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
zone — Required. Name of zone where the record will be updated.
GetKXRecords — Click for More Info
string fqdn — Required. Name of node where the record will be updating.
string token — Required. The session identifier.
string zone — Required. Name of zone where the record will be updated.
|
Response:
GetOneKXRecord — 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.
GetKXRecords — 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
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 (GetOneKXRecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'preference' => '10',
'exchange' => 'kx1.example.net',
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetKXRecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base