Understanding How The API Works »
Retrieving information on one Record Set or a list of Record Set resources 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.
NOTE: Total number of records in a single Response Pool may not be more than 255.
REST Syntax
Click to view all REST Resources |
/REST/DSFRecordSet/ GET — Retrieves a list of Record Set resources or the details of the specified Record Set.
HTTP Action — GET
URIs:
Get details of one Record Set — https://api.dynect.net/REST/DSFRecordSet/<service_id>/<dsf_record_set_id>/
Get list of Record Sets — https://api.dynect.net/REST/DSFRecordSet/<service_id>/
|
Arguments:
Get details of one Record Set: No Arguments.
Get list of Record Sets — Click for More Info
- string
label — Services with the specified label. Can be wild carded.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- string
automation — Defines how eligible can be changed in response to monitoring.
Valid values:
auto — Sets the serve_mode field to ‘Monitor & Obey’. Default.
auto_down — Sets the serve_mode field to ‘Monitor & Remove’.
manual — Couples with eligible value to determine other serve_mode field values.
- string
serve_count — How many Records to serve out of this Record Set.
- string
fail_count — The number of Records that must not be okay before the Record Set becomes ineligible.
- string
trouble_count — The number of Records that must not be okay before the Record Set becomes in trouble.
- string
eligible — Indicates whether or not the Record Set can be served.
Valid values:
false — When automation is set to manual, sets the serve_mode field to ‘Do Not Serve’.
true — Default. Not supported for Record Sets.
NOTE: Change eligible to false if automation is set to manual.
- string
status — The status of the pool indicated by any attached monitors.
- string
dsf_monitor_id — The id of the monitoring object.
- string
notify_id — The id of the notification object. An empty string searches for Record Sets that are not attached to monitors.
- string
dsf_record_set_failover_chain_id — The id of a Record Set Failover Chain. An empty string searches for Record Sets that do not belong to any Record Set Failover Chains.
- string
detail — A boolean indicating whether or not to return the full details or a list of service resources.
Valid values:
Y – The details of each service are specified.
N – The list of service resources is returned. ( Default )
- string
pending_changes — Indicates whether pending changes will be returned.
Valid values:
Y — Return all published objects plus pending changes along with the change type (add/modify/remove).
N — Return only published objects.
|
Response:
Get details of one Record Set — Click for More Info
- string
service_id — Identifier for the Traffic Director (DSF) Service.
- string
dsf_record_set_id — Identifier for the Record Set.
- string
dsf_monitor_id — The id of the monitoring object.
- string
label — A label for the Record Set.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- string
ttl_derived — The actual TTL used for Records within this Record Set.
- string
automation — Defines how eligible can be changed in response to monitoring.
Valid values:
auto — Sets the serve_mode field to ‘Monitor & Obey’. Default.
auto_down — Sets the serve_mode field to ‘Monitor & Remove’.
manual — Couples with eligible value to determine other serve_mode field values.
- string
serve_count — How many Records to serve out of this Record Set.
- string
fail_count — The number of Records that must not be okay before the Record Set becomes ineligible.
- string
trouble_count — The number of Records that must not be okay before the Record Set becomes in trouble.
- string
eligible — Indicates whether or not the Record Set can be served.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
records — A list of Records contained within the Record Set
- string
dsf_record_id — Identifier for the Record.
- string
service_id — The id of a Traffic Director (DSF) service.
- string
label — A label for the Record
- string
master_line — Master line for the Record
- string
weight — Weight for the Record. Defaults to 1.
Valid values for A or AAAA records: 1 – 15.
Valid values for CNAME records: 1 – 255.
- string
automation — Defines how eligible can be changed in response to monitoring.
Valid values:
auto — Sets the serve_mode field to ‘Monitor & Obey’. Default.
auto_down — Sets the serve_mode field to ‘Monitor & Remove’.
manual — Couples with eligible value to determine other serve_mode field values.
- array
endpoints — The individual address(es) for a record. Multiple addresses are added as an array [ addr, addr ]. Endpoints are monitored if automation is set to auto or auto_down and there is a monitor attached to the service.
- array
endpoint_up_count — Number of endpoints that must be up for the Record status to be ‘up’.
- string
eligible — Indicates whether or not the Record can be served.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- hash
rdata — RData that comprises the Record.
- string
status — The status of the pool indicated by any attached monitors
- string
response_time — Time it took to receive a response from the endpoints
- string
torpidity — Performance indicator for the Record. Lower is better.
- string
last_monitored — Epoch timestamp of the last time the Record Set was monitored
- string
pending_change — Indicates whether or not the object will be added, updated, or deleted.
string status — The status of the pool indicated by any attached monitors
string last_monitored — Epoch timestamp of the last time the Record Set was monitored
string pending_change — Indicates whether or not the response has any changes pending.
Get list of Record Sets: array — Individual Record Set resources.
|
SOAP Syntax
Click to view all SOAP Commands |
GetOneDSFRecordSet — Retrieves information about an existing Record Set.
GetDSFRecordSets — Retrieves all Record Set entries from a Traffic Director (DSF) service or a Record Set Failover Chain.
|
Arguments:
GetOneDSFRecordSet — Click for More Info
string service_id — Required. Identifier of the Traffic Director (DSF) service where the Record Set exists.
string dsf_record_set_id — Required. Record Set identifier.
string token — Required. The session identifier.
GetDSFRecordSets — Click for More Info
- string
service_id — Required. Identifier for the Traffic Director (DSF) Service.
- string
dsf_record_set_failover_chain_id — The id of a Record Set Failover Chain.
- string
label — Services with the specified label. Can be wild carded.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- string
automation — Defines how eligible can be changed in response to monitoring.
Valid values:
auto — Sets the serve_mode field to ‘Monitor & Obey’. Default.
auto_down — Sets the serve_mode field to ‘Monitor & Remove’.
manual — Couples with eligible value to determine other serve_mode field values.
- string
serve_count — How many Records to serve out of this Record Set.
- string
fail_count — The number of Records that must not be okay before the Record Set becomes ineligible.
- string
trouble_count — The number of Records that must not be okay before the Record Set becomes in trouble.
- string
eligible — Indicates whether or not the Record Set can be served.
Valid values:
false — When automation is set to manual, sets the serve_mode field to ‘Do Not Serve’.
true — Default. Not supported for Record Sets.
NOTE: Change eligible to false if automation is set to manual.
- string
status — The status of the pool indicated by any attached monitors.
- string
dsf_monitor_id — The id of the monitoring object.
- string
notify_id — The id of the notification object. An empty string searches for Record Sets that are not attached to monitors.
- string
token — Required. The session identifier.
|
Response:
GetOneDSFRecordSet — Click for More Info
- hash
data
- string
service_id — Identifier for the Traffic Director (DSF) Service.
- string
dsf_record_set_id — Identifier for the Record Set.
- string
dsf_monitor_id — The id of the monitoring object.
- string
label — A label for the Record Set.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- string
ttl_derived — The actual TTL used for Records within this Record Set.
- string
automation — Defines how eligible can be changed in response to monitoring.
Valid values:
auto — Sets the serve_mode field to ‘Monitor & Obey’. Default.
auto_down — Sets the serve_mode field to ‘Monitor & Remove’.
manual — Couples with eligible value to determine other serve_mode field values.
- string
serve_count — How many Records to serve out of this Record Set.
- string
fail_count — The number of Records that must not be okay before the Record Set becomes ineligible.
- string
trouble_count — The number of Records that must not be okay before the Record Set becomes in trouble.
- string
eligible — Indicates whether or not the Record Set can be served.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
records — A list of Records contained within the Record Set
- string
dsf_record_id — Identifier for the Record.
- string
service_id — The id of a Traffic Director (DSF) service.
- string
label — A label for the Record
- string
master_line — Master line for the Record
- string
weight — Weight for the Record. Defaults to 1.
Valid values for A or AAAA records: 1 – 15.
Valid values for CNAME records: 1 – 255.
- string
automation — Defines how eligible can be changed in response to monitoring.
Valid values:
auto — Sets the serve_mode field to ‘Monitor & Obey’. Default.
auto_down — Sets the serve_mode field to ‘Monitor & Remove’.
manual — Couples with eligible value to determine other serve_mode field values.
- array
endpoints — The individual address(es) for a record. Multiple addresses are added as an array [ addr, addr ]. Endpoints are monitored if automation is set to auto or auto_down and there is a monitor attached to the service.
- array
endpoint_up_count — Number of endpoints that must be up for the Record status to be ‘up’.
- string
eligible — Indicates whether or not the Record can be served.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- hash
rdata — RData that comprises the Record.
- string
status — The status of the pool indicated by any attached monitors
- string
response_time — Time it took to receive a response from the endpoints
- string
torpidity — Performance indicator for the Record. Lower is better.
- string
last_monitored — Epoch timestamp of the last time the Record Set was monitored
- string
pending_change — Indicates whether or not the object will be added, updated, or deleted.
- string
status — The status of the pool indicated by any attached monitors
- string
last_monitored — Epoch timestamp of the last time the Record Set was monitored
GetDSFRecordSets — Click for More Info
- array
data
- string
service_id — Identifier for the Traffic Director (DSF) Service.
- string
dsf_record_set_id — Identifier for the Record Set.
- string
dsf_monitor_id — The id of the monitoring object.
- string
label — A label for the Record Set.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- string
ttl_derived — The actual TTL used for Records within this Record Set.
- string
automation — Defines how eligible can be changed in response to monitoring.
Valid values:
auto — Sets the serve_mode field to ‘Monitor & Obey’. Default.
auto_down — Sets the serve_mode field to ‘Monitor & Remove’.
manual — Couples with eligible value to determine other serve_mode field values.
- string
serve_count — How many Records to serve out of this Record Set.
- string
fail_count — The number of Records that must not be okay before the Record Set becomes ineligible.
- string
trouble_count — The number of Records that must not be okay before the Record Set becomes in trouble.
- string
eligible — Indicates whether or not the Record Set can be served.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
records — A list of Records contained within the Record Set
- string
dsf_record_id — Identifier for the Record.
- string
service_id — The id of a Traffic Director (DSF) service.
- string
label — A label for the Record
- string
master_line — Master line for the Record
- string
weight — Weight for the Record. Defaults to 1.
Valid values for A or AAAA records: 1 – 15.
Valid values for CNAME records: 1 – 255.
- string
automation — Defines how eligible can be changed in response to monitoring.
Valid values:
auto — Sets the serve_mode field to ‘Monitor & Obey’. Default.
auto_down — Sets the serve_mode field to ‘Monitor & Remove’.
manual — Couples with eligible value to determine other serve_mode field values.
- array
endpoints — The individual address(es) for a record. Multiple addresses are added as an array [ addr, addr ]. Endpoints are monitored if automation is set to auto or auto_down and there is a monitor attached to the service.
- array
endpoint_up_count — Number of endpoints that must be up for the Record status to be ‘up’.
- string
eligible — Indicates whether or not the Record can be served.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- hash
rdata — RData that comprises the Record.
- string
status — The status of the pool indicated by any attached monitors
- string
response_time — Time it took to receive a response from the endpoints
- string
torpidity — Performance indicator for the Record. Lower is better.
- string
last_monitored — Epoch timestamp of the last time the Record Set was monitored
- string
pending_change — Indicates whether or not the object will be added, updated, or deleted.
- string
status — The status of the pool indicated by any attached monitors
- string
last_monitored — Epoch timestamp of the last time the Record Set was monitored
|
Example Request (GetOneDSFRecordSet) — Click for More Info
{
'service_id' => '0bi5k...', # ID shortened...
'dsf_record_set_id' => 'ab32f...', # ID shortened...
'token' => 'asdlj34ot879834cdzjklfK'
}
Example Request (GetDSFRecordSets) — Click for More Info
{
'service_id' => '0bi5k...', # ID shortened...
'eligible' => 'true',
'ttl' => '3600',
'token' => 'asdlj34ot879834cdzjklfK'
}
|
<< DNS API Knowledge Base