Retrieving one or all of the existing IPTrack services 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.
Understanding How The API Works »
REST Syntax
| Click to view all REST Resources |
| /REST/IPTrack/ GET — Retrieves one or all instances of the IPTrack service on the zone/node indicated.
HTTP Action — GET
URIs:
Get one IPTrack Service — https://api.dynect.net/REST/IPTrack/<zone>/<fqdn>/<service_id>/
Get all IPTrack Services — https://api.dynect.net/REST/IPTrack/<zone>/<fqdn>/ |
| Arguments:No Arguments. |
Response:Get one IPTrack Service — Click for More Info
- string
active — Indicates whether or not the service is active.
Valid values:
Y — The service is active.
N — The service is inactive.
- string
iptrack_id — The ID of this iptrack service.
- array
record_types — Types of records to track.
NOTE: A and AAAA sub types are not mixable, you must create two services if you want to track both A and AAAA type records.
Valid values:
A – A Records
DynA – Dynamic DNS A Records
AAAA – AAAA Records
DynAAAA – Dynamic DNS AAAA Records
- array
hosts — Hostnames of zones in your account where you want to track records.
- string
ttl — TTL for the created PTR records. Omit to use zone default.
Two special values are also supported:
match – Set the TTL of the PTR to the TTL of the record being pointed to
default – Use the default TTL of the zone for the PTR records. (Same as leaving it empty or omitting it)
- string
netmask — A netmask to match A/AAAA rdata against. Matched records will get PTR records, any others won’t.
- string
fqdn — Fully qualified domain name of a node in the zone.
- string
zone — Name of the zone.
Get all IPTrack Services — array — Individual service resources. |
SOAP Syntax
| Click to view all SOAP Commands |
| GetOneIPTrack — Retrieves an existing instance of the IPTrack service on the zone/node indicated.
GetIPTracks — Retrieves information for all existing IPTrack services on the zone/node indicated. |
Arguments:GetOneIPTrack — Click for More Info
string fqdn — Required.Fully qualified domain name of a node in the zone.
string token — Required. The session identifier.
string zone — Required. Name of the zone where the service will be added.
string iptrack_id — The ID of this iptrack service.
GetIPTracks — Click for More Info
string token — Required. The session identifier.
string zone — Required. Name of the zone where the service will be added.
|
Response:GetOneIPTrack — Click for More Info
- hash
data
- string
active — Indicates whether or not the service is active.
Valid values:
Y — The service is active.
N — The service is inactive
- string
iptrack_id — The ID of this iptrack service.
- array
record_types — Types of records to track.
NOTE: A and AAAA sub types are not mixable, you must create two services if you want to track both A and AAAA type records.
Valid values:
A – A Records
DynA – Dynamic DNS A Records
AAAA – AAAA Records
DynAAAA – Dynamic DNS AAAA Records
- array
hosts — Hostnames of zones in your account where you want to track records.
- string
ttl — TTL for the created PTR records. Omit to use zone default.
Two special values are also supported:
match – Set the TTL of the PTR to the TTL of the record being pointed to
default – Use the default TTL of the zone for the PTR records. (Same as leaving it empty or omitting it)
- string
netmask — A netmask to match A/AAAA rdata against. Matched records will get PTR records, any others won’t.
- string
fqdn — Fully qualified domain name of a node in the zone.
- string
zone — Name of the zone.
GetIPTracks — Click for More Info
- array
data
- string
active — Indicates whether or not the service is active.
Valid values:
Y — The service is active.
N — The service is inactive
- string
iptrack_id — The ID of this iptrack service.
- array
record_types — Types of records to track.
NOTE: A and AAAA sub types are not mixable, you must create two services if you want to track both A and AAAA type records.
Valid values:
A – A Records
DynA – Dynamic DNS A Records
AAAA – AAAA Records
DynAAAA – Dynamic DNS AAAA Records
- array
hosts — Hostnames of zones in your account where you want to track records.
- string
ttl — TTL for the created PTR records. Omit to use zone default.
Two special values are also supported:
match – Set the TTL of the PTR to the TTL of the record being pointed to
default – Use the default TTL of the zone for the PTR records. (Same as leaving it empty or omitting it)
- string
netmask — A netmask to match A/AAAA rdata against. Matched records will get PTR records, any others won’t.
- string
fqdn — Fully qualified domain name of a node in the zone.
- string
zone — Name of the zone.
|
Example Request (GetOneIPTrack) — Click for More Info
{
'fqdn' => 'reverse.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'iptrack_id' => '3',
'token' => 'asdlkfjasl23j4879afa',
}
|
Example Request (GetIPTracks) — Click for More Info
{
'zone' => 'example.com',
'token' => 'asdlj34ot879834cdzjklfK',
}
|
DNS API Knowledge Base
