Delete Traffic Director (DSF) Response Pool (API)

Removing a Response Pool 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/DSFResponsePool/ DELETE — Deletes the specified Response Pool.

HTTP Action — DELETE

URIs — https://api.dynect.net/REST/DSFResponsePool/<service_id>/<dsf_response_pool_id>/

Arguments:

string publish — Indicates when Response Pool will be removed.
Valid values:
Y — The Response Pool will be deleted on execution.
N — The Response Pool will be deleted when zone changes are next published.

string notes — A custom note field. All content in the string is added to the Zone Notes for the zones attached to this service when the zone is published. Only used when publish = Y

Response — Click for More Info

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.
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 (DSF) 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 theTraffic Director (DSF) Service.
  - 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 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 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 flags
        
        string protocol Numeric value for the protocol used 1= TLS, 2=Email, 3=DNSSEC, 4= IPsec
        
        string public_key The public key
        
        hash kx_rdata — KX record rdata.
        
        string preference Similar to the MX record’s preference. Lower value (10) takes precedence over higher value (20) if multiple KX records exist on the same node
        
        string exchange The hostname that will act as the key exchanger. Must have a CNAME record and either an A record or an AAAA record
        
        hash loc_rdata — LOC record rdata.
        
        string altitude Measured in meters above sea level Example: -44m
        
        string horiz_pre Precision in meters Example: 30m
        
        string latitude Measured in degrees, minutes, and seconds Example: 42 21 54 N
        
        string longitude Measured in degrees, minutes, and seconds Example: 71 06 18 W
        
        string size Size in meters Example: 10m
        
        string version
        
        string vert_pre Precision in meters Example 10m
        
        hash mx_rdata — MX record rdata.
        
        string exchange Hostname of the server responsible for accepting mail messages in the zone
        
        string preference The MX record with the lowest preference number is used first, then the record with the next highest number
        
        hash naptr_rdata — NAPTR record rdata.
        
        string order Similar to the MX Record’s preference value or SRV record’s priority value. The lowest value is used first, highest value used last
        
        string preference If one or more NAPTR records have the same value for ORDER, the value of preference is used to decide which record is used first. Lowest number goes first
        
        string flags
        
        string services Always starts with e2u+ then the string that defines the type and optionally the subtype of the URI where this NAPTR points
        
        string regexp Enter regular expression for this NAPTR record
        
        string replacement Specifies the next domain name to look up if this is a non-terminal NAPTR
        
        hash ns_rdata — NS record rdata.
        
        string nsdname Hostname of the authoritative Nameserver for this zone
        
        hash nsap_rdata — NSAP record rdata.
        
        string nsap — Hex-encoded NSAP identifier.
        
        hash ptr_rdata — PTR record rdata.
        
        string ptrdname Hostname where the IP address should be directed
        
        hash px_rdata — PX record rdata.
        
        string preference — numeric preference.
        
        string map822 — mail hostname.
        
        string mapx400 — X.400 address mapping.
        
        hash rp_rdata — RP record rdata.
        
        string mbox Email address of the Responsible Person with the @ symbol replaced with a dot ‘.’
        
        string txtdname Hostname where there is a TXT record with more information
        
        hash soa_rdata — SOA record rdata.
        
        integer expireSet to 1 week by default. The time, in seconds, that a secondary server will keep trying to complete a zone transfer.
        
        integer minimumSet to 1 minute by default.
        
        string mname
        
        integer refreshSet to 1 hour by default. The time, in seconds, a secondary DNS server waits before querying the primary DNS Server’s SOA record to check for changes.
        
        integer retrySet to 10 minutes by default. The time, in seconds, a secondary DNS Server waits before retrying a failed zone transfer.
        
        string rname
        
        integer serialValue increments when any resource record in the zone file is updated.
        
        hash spf_rdata — SPF record rdata.
        
        string txtdata Free text box
        
        hash srv_rdata — SRV record rdata.
        
        string port — Port number where the service is running.
        
        string priority — Numeric value for priority usage. Lower value takes precedence where two records of the same type exist on the zone/node.
        
        string target — Domain name of a host where the service is running on the specified port.
        
        string weight — Secondary prioritizing of records to serve. Records of equal priority should be served based on their weight.
        
        hash sshfp_rdata — SSHFP record rdata.
        
        string algorithm — algorithm for SSH key.
        
        string fptype — type of fingerprint hash.
        
        string fingerprint — hex-encoded fingerprint.
        
        hash txt_rdata — TXT record rdata.
        
        string txtdata Free text field
      - 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.
- 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

SOAP Syntax

Click to view all SOAP Commands

DeleteOneDSFResponsePool — Removes an existing Response Pool.

Arguments:

string service_id — Identifier for the Traffic Director (DSF) service where the Response Pool belongs.
string dsf_response_pool_id — Identifier for the Response Pool to delete.
string publish — Indicates when Response Pool will be removed.
Valid values:
Y — The Response Pool will be deleted on execution.
N — The Response Pool will be deleted when zone changes are next published.
string notes — A custom note field. All content in the string is added to the Zone Notes for the zones attached to this service when the zone is published. Only used when publish = Y
string token — Required. The session identifier.

Response — Click for More Info

hash data
- 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.
- 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 (DSF) 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 (DSF) Service.
    - 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.
    - array records — A list of DSF 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 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 flags
        
        string protocol Numeric value for the protocol used 1= TLS, 2=Email, 3=DNSSEC, 4= IPsec
        
        string public_key The public key
        
        hash kx_rdata — KX record rdata.
        
        string preference Similar to the MX record’s preference. Lower value (10) takes precedence over higher value (20) if multiple KX records exist on the same node
        
        string exchange The hostname that will act as the key exchanger. Must have a CNAME record and either an A record or an AAAA record
        
        hash loc_rdata — LOC record rdata.
        
        string altitude Measured in meters above sea level Example: -44m
        
        string horiz_pre Precision in meters Example: 30m
        
        string latitude Measured in degrees, minutes, and seconds Example: 42 21 54 N
        
        string longitude Measured in degrees, minutes, and seconds Example: 71 06 18 W
        
        string size Size in meters Example: 10m
        
        string version
        
        string vert_pre Precision in meters Example 10m
        
        hash mx_rdata — MX record rdata.
        
        string exchange Hostname of the server responsible for accepting mail messages in the zone
        
        string preference The MX record with the lowest preference number is used first, then the record with the next highest number
        
        hash naptr_rdata — NAPTR record rdata.
        
        string order Similar to the MX Record’s preference value or SRV record’s priority value. The lowest value is used first, highest value used last
        
        string preference If one or more NAPTR records have the same value for ORDER, the value of preference is used to decide which record is used first. Lowest number goes first
        
        string flags
        
        string services Always starts with e2u+ then the string that defines the type and optionally the subtype of the URI where this NAPTR points
        
        string regexp Enter regular expression for this NAPTR record
        
        string replacement Specifies the next domain name to look up if this is a non-terminal NAPTR
        
        hash ns_rdata — NS record rdata.
        
        string nsdname Hostname of the authoritative Nameserver for this zone
        
        hash nsap_rdata — NSAP record rdata.
        
        string nsap — Hex-encoded NSAP identifier.
        
        hash ptr_rdata — PTR record rdata.
        
        string ptrdname Hostname where the IP address should be directed
        
        hash px_rdata — PX record rdata.
        
        string preference — numeric preference.
        
        string map822 — mail hostname.
        
        string mapx400 — X.400 address mapping.
        
        hash rp_rdata — RP record rdata.
        
        string mbox Email address of the Responsible Person with the @ symbol replaced with a dot ‘.’
        
        string txtdname Hostname where there is a TXT record with more information
        
        hash soa_rdata — SOA record rdata.
        
        integer expireSet to 1 week by default. The time, in seconds, that a secondary server will keep trying to complete a zone transfer.
        
        integer minimumSet to 1 minute by default.
        
        string mname
        
        integer refreshSet to 1 hour by default. The time, in seconds, a secondary DNS server waits before querying the primary DNS Server’s SOA record to check for changes.
        
        integer retrySet to 10 minutes by default. The time, in seconds, a secondary DNS Server waits before retrying a failed zone transfer.
        
        string rname
        
        integer serialValue increments when any resource record in the zone file is updated.
        
        hash spf_rdata — SPF record rdata.
        
        string txtdata Free text box
        
        hash srv_rdata — SRV record rdata.
        
        string port — Port number where the service is running.
        
        string priority — Numeric value for priority usage. Lower value takes precedence where two records of the same type exist on the zone/node.
        
        string target — Domain name of a host where the service is running on the specified port.
        
        string weight — Secondary prioritizing of records to serve. Records of equal priority should be served based on their weight.
        
        hash sshfp_rdata — SSHFP record rdata.
        
        string algorithm — algorithm for SSH key.
        
        string fptype — type of fingerprint hash.
        
        string fingerprint — hex-encoded fingerprint.
        
        hash txt_rdata — TXT record rdata.
        
        string txtdata Free text field
        
        string status — The status of the pool indicated by any attached monitors
        
        Valid values:
        ok — The object is available (up).
        unknown — The object has not provided a status to the monitor.
        down — Response Pool unable to satisfy core sets, Ineligible due to previous failure, or End of failover for Record Set
        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.
  - 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

Example Request — Click for More Info

{
	'service_id'		=> 'fv298...',		# ID shortened...
	'dsf_response_pool_id'	=> '4ae3n...',		# ID shortened...
	'publish'		=> 'Y'
	'token'			=> 'asdlj34ot879834cdzjklfK'
}

<< DNS API Knowledge Base

REST Syntax	Associated API Topics
SOAP Syntax	Create Traffic Director (DSF) Response Pool (API)
	Update Traffic Director (DSF) Response Pool (API)
	Get Traffic Director (DSF) Response Pool(s) (API)