Retrieving one or all existing PX 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 2163 for more information about PX records.
See RFC 822 for more information about the domain name part of MCGAM.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/PXRecord/ GET — Retrieve one or all existing PX records on the zone/node indicated.
HTTP Action — GET
URIs:
Get one PX record — https://api.dynect.net/REST/PXRecord/<zone>/<fqdn>/<record_id>/
Get all PX records — https://api.dynect.net/REST/PXRecord/<zone>/<fqdn>/ |
Arguments:
No Arguments. |
Response:
Get one PX record — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record(s) to replace.
- string
preference — Sets priority for processing records of the same type. Lowest value is processed first.
- string
map822 — mail hostname
- string
mapx400 — Enter the domain name derived from the X.400 part of MCGAM.
- string
record_type — The RR Type of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
Get all PX records — array — Individual PX records. |
SOAP Syntax
Click to view all SOAP Commands |
GETOnePXRecord — Retrieve one existing PX record on the zone/node indicated.
GETPXRecords — Retrieve all existing PX records on the zone/node indicated. |
Arguments:
GetOnePXRecord — Click for More Info
- string
fqdn — Required. Fully qualified domain name of a node in the zone.
- string
record_id — A numeric identifier for the record.
- hash
rdata — RData defining the record.
- string
preference — Required. Sets priority for processing records of the same type. Lowest value is processed first.
- string
map822 — Required. mail hostname
- string
mapx400 — Required. Enter the domain name derived from the X.400 part of MCGAM.
- string
token — Required. The session identifier.
- string
zone — Required. Name of the zone.
GetPXRecords — Click for More Info
string fqdn — Required. Name of node where the record exists.
string token — Required. The session identifier.
string zone — Required. Name of zone where the record exists.
|
Response:
GetOnePXRecord — 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
preference — Sets priority for processing records of the same type. Lowest value is processed first.
- string
map822 — mail hostname
- string
mapx400 — Enter the domain name derived from the X.400 part of MCGAM.
- 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.
GetPXRecords — 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
preference — Sets priority for processing records of the same type. Lowest value is processed first.
- string
map822 — mail hostname
- string
mapx400 — Enter the domain name derived from the X.400 part of MCGAM.
- 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 (GetOnePXRecord) — Click for More Info
{
'fqdn' => 'somehost.example.com',
'rdata' => {
'preference' => '10',
'map822' => 'gateway.example.com',
'mapx400' => 'PRMD-ab.ADMD-ac.C-us.',
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'somehost.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetPXRecords) — Click for More Info
{
'fqdn' => 'somehost.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base