Retrieving one or all existing RP 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 1183 for more information about RP records.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/RPRecord/ GET — Retrieve one or all existing RP records on the zone/node indicated.
HTTP Action — GET
URIs:
Get one RP record — https://api.dynect.net/REST/RPRecord/<zone>/<fqdn>/<record_id>/
Get all RP records — https://api.dynect.net/REST/RPRecord/<zone>/<fqdn>/ |
Arguments:
No Arguments. |
Response:
Get one RP 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
mbox — Email address of the Responsible Person. Data format: Replace @ symbol with a dot ‘.’ in the address. Example: mail.sample.com
- string
txtdname — Hostname where a TXT record exists with more information on the responsible person.
- string
record_type — The RR Type of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
Get all RP records — array — Individual RP records. |
SOAP Syntax
Click to view all SOAP Commands |
GETOneRPRecord — Retrieve one existing RP record on the zone/node indicated.
GETRPRecords — Retrieve all existing RP records on the zone/node indicated. |
Arguments:
GetOneRPRecord — 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
mbox — Required. Email address of the Responsible Person. Data format: Replace @ symbol with a dot ‘.’ in the address. Example: mail.sample.com
- string
txtdname — Required. Hostname where a TXT record exists with more information on the responsible person.
- string
token — Required. The session identifier.
- string
zone — Required. Name of the zone.
GetRPRecords — 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:
GetOneRPRecord — 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
mbox — Email address of the Responsible Person. Data format: Replace @ symbol with a dot ‘.’ in the address. Example: mail.sample.com
- string
txtdname — Hostname where a TXT record exists with more information on the responsible person.
- 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.
GetRPRecords — 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
mbox — Email address of the Responsible Person. Data format: Replace @ symbol with a dot ‘.’ in the address. Example: mail.sample.com
- string
txtdname — Hostname where a TXT record exists with more information on the responsible person.
- 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 (GetOneRPRecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'mbox' => 'admin.example.com',
'txtdname' => 'admin.example.com',
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetRPRecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
<< DNS API Knowledge Base