Retrieving one or more child SYNC 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 7477 for more information about the CSYNC record.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/CSYNCRecord/ GET — Retrieve one or all existing CSYNC Record on the zone/node indicated.
HTTP Action — GET
URIs:
Get one CSYNC Record — https://api.dynect.net/REST/CSYNCRecord/<zone>/<fqdn>/<record_id>/
Get CSYNC Records — https://api.dynect.net/REST/CSYNCRecord/<zone>/<fqdn>/ |
Arguments:
No Arguments. |
Response:
Get one CSYNC Record — Click for More Info
- string
fqdn — Name of node where the record resides.
- hash
rdata — RData defining the record.
- string
soa_serial — Required. A copy of the 32-bit SOA serial number from the child zone.
- string
flags — Required. Flags that define operations that affect the processing of the CSYNC record.
Valid values:
1 — immediate
2 — soaminimum
3 — immediate AND soaminimum
- string
types — Required. Types covered by this record. Can be any/all of NS/A/AAAA.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of zone where the record resides.
Get CSYNC Records: array — Individual CSYNC records. |
SOAP Syntax
Click to view all SOAP Commands |
GetOneCSYNCRecord — Retrieve the specified CSYNC Record on the zone/node indicated.
GetCSYNCRecords — Retrieve all CSYNC Records on the zone/node indicated. |
Arguments:
GetOneCSYNCRecord — Click for More Info
- string
fqdn — Required. Name of node where the record resides.
- string
record_id — If specified, the ID of the record to find.
- hash
rdata — Required. RData defining the record.
- string
soa_serial — Required. A copy of the 32-bit SOA serial number from the child zone.
- string
flags — Required. Flags that define operations that affect the processing of the CSYNC record.
Valid values:
1 — immediate
2 — soaminimum
3 — immediate AND soaminimum
- string
types — Required. Types covered by this record. Can be any/all of NS/A/AAAA.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where the record resides.
GetCSYNCRecords — Click for More Info
string fqdn — Required. Name of node where the record resides.
string token — Required. The session identifier.
string zone — Required. Name of zone where the record resides.
|
Response:
GetOneCSYNCRecord — 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
soa_serial — A copy of the 32-bit SOA serial number from the child zone.
- string
flags — Flags that define operations that affect the processing of the CSYNC record.
Valid values:
1 — immediate
2 — soaminimum
3 — immediate AND soaminimum
- string
types — Types covered by this record. Can be any/all of NS/A/AAAA.
- 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.
GetCSYNCRecords — 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
soa_serial — A copy of the 32-bit SOA serial number from the child zone.
- string
flags — Flags that define operations that affect the processing of the CSYNC record.
Valid values:
1 — immediate
2 — soaminimum
3 — immediate AND soaminimum
- string
types — Types covered by this record. Can be any/all of NS/A/AAAA.
- 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 (GetOneCSYNCRecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'flags' => '2',
'soa_serial' => '7dkesijE39Kes . . . . ',
'types' => 'AAAA',
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetCSYNCRecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
<< DNS API Knowledge Base