Get Traffic Director (DSF) Service (API)

Retrieving one or more instances of the Traffic Director service 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.

string detail — A boolean indicating whether or not to return a list of service resources. Service resources returned are: pending changesets, whether or not the service is active, the service TTL, the service ID, and the service label.
Valid values:Y – Return the service resources for each DSF service.N – Do not return a list of service resources. (Default)

Get all Traffic Director (DSF) instances:

string label — Services with the specified label. Can be wild carded.NOTE: The wildcard character is an asterisk ( * ). For example, searching on ( test* ) will return any value with the word test followed by other characters. Some examples are: miketest123, test123, and testcase.

Response:

Get One Traffic Director (DSF) Instance — Click for More Info

string service_id — Identifier for the Traffic Director service.

string label Name of the Traffic Director service.

string active — Indicates whether or not the Traffic Director service is active.
Valid values:Y if the service is active.N if the service is inactive.

string ttl — The default TTL to be used across the Traffic Director service.

string criteria_type — A set of rules describing what traffic is applied to the response pool.
Valid values:always – Always serve. Use to create a catch-all ruleset, which resolves all queries regardless of requestor’s IP address.geoip – Use the location of the requestor’s IP address to determine where to send the traffic.

string pending_change — Indicates whether or not the response has any changes pending.

array response_pools — A list of Response Pools that are contained within the Ruleset.

string dsf_response_pool_id — Identifier for the Response Pool.

string label — A label for the Response Pool.

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 core_set_count — If fewer than this number of core record sets are eligible, status will be set to fail. Defaults to 0.

string eligible — Indicates whether or not the Response Pool can be served.

string pending_change — Indicates whether or not the response has any changes pending.
Valid values:Y — All items, both active and pending are returned.N — All active items are returned.

array rs_chains — A list of Record Set Failover Chains that are defined for this Response Pool.

string dsf_record_set_failover_chain_id — Identifier for the Record Set Failover Chain.

string dsf_response_pool_id — Identifier for the Response Pool where the Record Set Failover Chain belongs.

string service_id — Identifier for the Traffic Director service where the Record Set Failover Chain belongs.

string label — A label for the Record Set Failover Chain.

string core — If True, identifies the Record Set Failover Chain as a core Record Chain.

array record_sets — A non-detailed list of Record Sets contained in the chain.

string service_id — Identifier for the Traffic Director Service.

string dsf_monitor_id — The id of the monitoring object.

string dsf_record_set_id — Identifier for the Record Set.

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 DSF 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.

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 type — The type of rdata.

string ttl — Default TTL used for Record.

hash data

hash a_rdata — A record rdata.

string address — IPv4 Address.

hash aaa_rdata — AAAA record rdata.

string address — IPv6 Address.

hash cert_rdata — CERT record rdata

string format Must use the numeric value for Certificate Type. Example: 3

string tag Identifies which private key was used to sign the public-key certificate. Must use a numeric value for the Key Tag

string algorithm The public-key algorithm number used to generate the certificate. Example: if RSA/SHA 1 was used, its algorithm # is 5, which would be placed in this field

string certificate Enter the actual public-key certificate

hash cname_rdata — CNAME record rdata.

string cname — Hostname.

hash dhcid_rdata — DHCID record rdata.

string digest — Base-64 encoded digest of DHCP data.

hash dname_rdata — DNAME record rdata.

string dname — Target hostname.

hash dnskey_rdata — DNSKEY record rdata.

string algorithm Required. Which public-key encryption algorithm is to sign this zone. A value of 5 is for the algorithm RSA/SHA-1, which is considered mandatory

string flags Required. Numeric value that states that this DNSKEY is the zone’s key

string protocol Always set to 3 (DNSSEC)

string public_key Enter the DNSSEC public key from your current DNSSEC signed zone

hash ds_rdata — DS record rdata.

string algorithm — The algorithm number used by the DNSKEY resource record.

string digest — The digest of the DNSKEY resource record this DS refers to.

string digtype — Identifies the algorithm used to construct the digest.

string keytag — The key tag of the DNSKEY resource record.

hash ipseckey_rdata — IPSECKEY record rdata.

string precedence Similar to the preference value in MX records. IF multiple IPSECKEYs exist on a node, the lower value (10) takes precedence over the higher value (20)

string gatetype Value that states what type of gateway is used, if any

string algorithm Identifies the public key’s cryptographic algorithm and the format of the public key field

string gateway The gateway used to create the IPsec tunnel. Based on the Gateway type

string public_key Base 64 encoding of the public key

hash key_rdata — KEY record rdata.

string algorithm Numeric value for the algorithm used RSA/MD5, the recommended algorithm, is 1

string label — Label used to describe the Traffic Director (DSF) service. Can be wild carded.NOTE: The wildcard character is an asterisk ( * ). For example, searching on ( test* ) will return any value with the word test followed by other characters. Some examples are: miketest123, test123, and testcase.

string token — Required. The session identifier.

Response:

GetOneDSF — Click for More Info

hash data

string service_id — Identifier for the Traffic Director service.

string label Name of the Traffic Director service.

string active — Indicates whether or not the service is active.
Valid values:Y if the service is active.N if the service is inactive.

string ttl — The default TTL to be used across the service.

string link_id — ID representing the link.

string active — Indicates whether or not the link is active.

array notifiers — List of notifiers associated with the service.

string notifier_id — ID of the Notifier object.

string label — label of the notifier.

array recipients — List of recipients for this notifier.

string active — Indicates whether or not the Notifier is active.

array rulesets — A list of Rulesets that are defined for the service:

string dsf_ruleset_id — Identifier for the Ruleset.

string label — A label for the Ruleset.

string criteria_type — A set of rules describing what traffic is applied to the Response Pool.
Valid values:always – Always serve. Use to create a catch-all ruleset, which resolves all queries regardless of requestor’s IP address.geoip – Use the location of the requestor’s IP address to determine where to send the traffic.

string pending_change — Indicates whether or not the Response Pool has any changes pending.

array response_pools — A list of Response Pools that are contained within the DSF Ruleset.

string dsf_response_pool_id — Identifier for the Response Pool.

string label — A label for the Response Pool.

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 core_set_count — If fewer than this number of core record sets are eligible, status will be set to fail. Defaults to 0.

string eligible — Indicates whether or not the Response Pool can be served.

string pending_change — Indicates whether or not the Response Pool has any changes pending.

array rs_chains — A list of Record Set Failover Chains that are defined for this Response Pool.

string dsf_record_set_failover_chain_id — Identifier for the Record Set Failover Chain.

string dsf_response_pool_id — Identifier for the Response Pool where the Record Set Failover Chain belongs.

string service_id — Identifier for the Traffic Director service where the Record Set Failover Chain belongs.

string label — A label for the Record Set Failover Chain.

string core — If True, identifies the Record Set Failover Chain as a core Record Chain.

array record_sets — A non-detailed list of Record Sets contained in the chain.

string service_id — Identifier for the Traffic Director Service.

string dsf_monitor_id — The id of the monitoring object.

string dsf_record_set_id — Identifier for the Record Set.

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 Pool has any changes pending.

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 DSF 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 type — The type of rdata.

string ttl — Default TTL used for DSF Record.

hash data

hash a_rdata — A record rdata.

string address — IPv4 Address.

hash aaa_rdata — AAAA record rdata.

string address — IPv6 Address.

hash cert_rdata — CERT record rdata

string format Must use the numeric value for Certificate Type. Example: 3

string tag Identifies which private key was used to sign the public-key certificate. Must use a numeric value for the Key Tag

string algorithm The public-key algorithm number used to generate the certificate. Example: if RSA/SHA 1 was used, its algorithm # is 5, which would be placed in this field

string certificate Enter the actual public-key certificate

hash cname_rdata — CNAME record rdata.

string cname — Hostname.

hash dhcid_rdata — DHCID record rdata.

string digest — Base-64 encoded digest of DHCP data.

hash dname_rdata — DNAME record rdata.

string dname — Target hostname.

hash dnskey_rdata — DNSKEY record rdata.

string algorithm Required. Which public-key encryption algorithm is to sign this zone. A value of 5 is for the algorithm RSA/SHA-1, which is considered mandatory

string flags Required. Numeric value that states that this DNSKEY is the zone’s key

string protocol Always set to 3 (DNSSEC)

string public_key Enter the DNSSEC public key from your current DNSSEC signed zone

hash ds_rdata — DS record rdata.

string algorithm — The algorithm number used by the DNSKEY resource record.

string digest — The digest of the DNSKEY resource record this DS refers to.

string digtype — Identifies the algorithm used to construct the digest.

string keytag — The key tag of the DNSKEY resource record.

hash ipseckey_rdata — IPSECKEY record rdata.

string precedence Similar to the preference value in MX records. IF multiple IPSECKEYs exist on a node, the lower value (10) takes precedence over the higher value (20)

string gatetype Value that states what type of gateway is used, if any

string algorithm Identifies the public key’s cryptographic algorithm and the format of the public key field

string gateway The gateway used to create the IPsec tunnel. Based on the Gateway type

string public_key Base 64 encoding of the public key

hash key_rdata — KEY record rdata.

string algorithm Numeric value for the algorithm used RSA/MD5, the recommended algorithm, is 1

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.

array rulesets — A list of Rulesets that contain this Response Pool.

string status — The status of the pool indicated by any attached monitors.

string last_monitored — Epoch timestamp of the last time the Response Pool was monitored.

array nodes — A list of zone and FQDN pairs to identify nodes that are attached to the Traffic Director service.

string zone — Name of the zone.

string fqdn — Fully qualified domain name of a node in the zone.

string pending_change — Indicates whether or not the service has any changes pending.
Valid values:Y – There are changes pending for this service.N – There are no changes pending for this service.

GetDSFs — Click for More Info

hash data

string service_id — Identifier for the Traffic Director service.

string label Name of the Traffic Director service.

string active — Indicates whether or not the service is active.
Valid values:Y if the service is active.N if the service is inactive.

string ttl — The default TTL to be used across the service.

string link_id — ID representing the link.

string active — Indicates whether or not the link is active.

array notifiers — List of notifiers associated with the service.

string notifier_id — ID of the Notifier object.

string label — label of the notifier.

array recipients — List of recipients for this notifier.

string active — Indicates whether or not the Notifier is active.

array rulesets — A list of Rulesets that are defined for the service:

string dsf_ruleset_id — Identifier for the Ruleset.

string label — A label for the Ruleset.

string criteria_type — A set of rules describing what traffic is applied to the Response Pool.
Valid values:always – Always serve. Use to create a catch-all ruleset, which resolves all queries regardless of requestor’s IP address.geoip – Use the location of the requestor’s IP address to determine where to send the traffic.

string pending_change — Indicates whether or not the Response Pool has any changes pending.

array response_pools — A list of Response Pools that are contained within the DSF Ruleset.

string dsf_response_pool_id — Identifier for the Response Pool.

string label — A label for the Response Pool.

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 core_set_count — If fewer than this number of core Record Sets are eligible, status will be set to fail.

string eligible — Indicates whether or not the Response Pool can be served.

string pending_change — Indicates whether or not the Response Pool has any changes pending.

array rs_chains — A list of Record Set Failover Chains that are defined for this Response Pool.

string dsf_record_set_failover_chain_id — Identifier for the Record Set Failover Chain.

string dsf_response_pool_id — Identifier for the Response Pool where the Record Set Failover Chain belongs.

string service_id — Identifier for the Traffic Director service where the Record Set Failover Chain belongs.

string label — A label for the Record Set Failover Chain.

string core — If True, identifies the Record Set Failover Chain as a core Record Chain.

array record_sets — A non-detailed list of Record Sets contained in the chain.

string service_id — Identifier for the Traffic Director Service.

string dsf_monitor_id — The id of the monitoring object.

string dsf_record_set_id — Identifier for the Record Set.

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 Pool has any changes pending.

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 DSF 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 type — The type of rdata.

string ttl — Default TTL used for DSF Record.

hash data

hash a_rdata — A record rdata.

string address — IPv4 Address.

hash aaa_rdata — AAAA record rdata.

string address — IPv6 Address.

hash cert_rdata — CERT record rdata

string format Must use the numeric value for Certificate Type. Example: 3

string tag Identifies which private key was used to sign the public-key certificate. Must use a numeric value for the Key Tag

string algorithm The public-key algorithm number used to generate the certificate. Example: if RSA/SHA 1 was used, its algorithm # is 5, which would be placed in this field

string certificate Enter the actual public-key certificate

hash cname_rdata — CNAME record rdata.

string cname — Hostname.

hash dhcid_rdata — DHCID record rdata.

string digest — Base-64 encoded digest of DHCP data.

hash dname_rdata — DNAME record rdata.

string dname — Target hostname.

hash dnskey_rdata — DNSKEY record rdata.

string algorithm Required. Which public-key encryption algorithm is to sign this zone. A value of 5 is for the algorithm RSA/SHA-1, which is considered mandatory

string flags Required. Numeric value that states that this DNSKEY is the zone’s key

string protocol Always set to 3 (DNSSEC)

string public_key Enter the DNSSEC public key from your current DNSSEC signed zone

hash ds_rdata — DS record rdata.

string algorithm — The algorithm number used by the DNSKEY resource record.

string digest — The digest of the DNSKEY resource record this DS refers to.

string digtype — Identifies the algorithm used to construct the digest.

string keytag — The key tag of the DNSKEY resource record.

hash ipseckey_rdata — IPSECKEY record rdata.

string precedence Similar to the preference value in MX records. IF multiple IPSECKEYs exist on a node, the lower value (10) takes precedence over the higher value (20)

string gatetype Value that states what type of gateway is used, if any

string algorithm Identifies the public key’s cryptographic algorithm and the format of the public key field

string gateway The gateway used to create the IPsec tunnel. Based on the Gateway type

string public_key Base 64 encoding of the public key

hash key_rdata — KEY record rdata.

string algorithm Numeric value for the algorithm used RSA/MD5, the recommended algorithm, is 1