Create Geo Traffic Manager (classic) (API)

Understanding How The API Works »

Creating a new Geo Traffic Manager (Classic) 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.

Please see the list of ISO-3166 two letter codes for the names of countries and their subdivisions or one of the predefined groups for the countries array.

NOTE: The Geo Traffic Management (classic) Service is deprecated. Legacy users of the service should contact Concierge for any questions on adding a Geo Traffic Management (classic) service to your zone. All other users should use Traffic Director instead.

REST Syntax

Click to view all REST Resources

/REST/Geo/ POST — Create a new Geo Traffic Manager service on the zone/node indicated.

HTTP Action — POST

URI — https://api.dynect.net/REST/Geo/<service_name>/

Arguments — Click for More Info

string ttl — Time to Live for each record in the service.
array groups — Required. A list of region groups.

string name — Required. Name of the Region Group.
hash weight — Weight for each record that is entered.

array a_weight — Weight for each record that is entered.
array aaaa_weight — Weight for each record that is entered.
array cname_weight — Weight for each record that is entered.

hash serve_count — Serve count for each record.

string a_serve_count — Serve count for each record.
string aaaa_serve_count — Serve count for each record.

hash ttl — Time to Live for each record

string a_ttl — TTL for each A record
string aaaa_ttl — TTL count for each AAAA record
string cname_ttl — TTL count for each CNAME record
string cert_ttl — TTL count for each CERT record
string mx_ttl — TTL count for each MX record
string txt_ttl — TTL count for each TXT record
string spf_ttl — TTL count for each SPF record
string ptr_ttl — TTL count for each PTR record
string loc_ttl — TTL count for each LOC record
string srv_ttl — TTL count for each SRV record
string rp_ttl — TTL count for each RP record
string key_ttl — TTL count for each KEY record
string dnskey_ttl — TTL count for each DNSKEY record
string sshfp_ttl — TTL count for each SSHFP record
string dhcid_ttl — TTL count for each DHCID record
string nsap_ttl — TTL count for each NSAP record
string px_ttl — TTL count for each PX record

hash label — Label for each record

array a_label — Label for each A record
array aaaa_label — Label for each AAAA record
array cname_label — Label for each CNAME record
array cert_label — Label for each CERT record
array mx_label — Label for each MX record
array txt_label — Label for each TXT record
array spf_label — Label for each SPF record
array ptr_label — Label for each PTR record
array loc_label — Label for each LOC record
array srv_label — Label for each SRV record
array rp_label — Label for each RP record
array key_label — Label for each KEY record
array dnskey_label — Label for each DNSKEY record
array sshfp_label — Label for each SSHFP record
array dhcid_label — Label for each DHCID record
array nsap_label — Label for each NSAP record
array px_label — Label for each PX record

array countries — Required. A list of ISO-3166 two letter codes to represent the names of countries and their subdivisions or one of the predefined groups.
hash rdata — Required. The records to be served for the Region Group.

Note: Each element in the following rdata arrays is a hash containing the string elements that follow the rdata array.

array a_rdata — A records to attach to the Region Group.

string address — Required. IPv4 Address

array aaaa_rdata — AAAA records to attach to the Region Group.

string address — Required. IPv6 Address

array cert_rdata — CERT records to attach to the Region Group.

string format — Required.
string tag — Required.
string algorithm — Required.
string certificate — Required.

array cname_rdata — CNAME records to attach to the Region Group.

string cname — Required.Hostname

array dhcid_rdata — DHCID records to attach to the Region Group.

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

array dname_rdata — DNAME records to attach to the Region Group.

string dname — Required. Target hostname

array dnskey_rdata — DNSKEY records to attach to the Region Group.

string algorithm — Required.
string flags — Required.
string protocol — Required.
string public_key — Required.

array ds_rdata — DS records to attach to the Region Group.

string algorithm — Required.
string digest — Required.
string digtype — Required.
string keytag — Required.

array ipseckey_rdata — IPSECKEY records to attach to the Region Group.

string precedence — Required.
string gatetype — Required.
string algorithm — Required.
string gateway — Required.
string public_key — Required.

array key_rdata — KEY records to attach to the Region Group.

string algorithm — Required.
string flags — Required.
string protocol — Required.
string public_key — Required.

array kx_rdata — KX records to attach to the Region Group.

string preference — Required.
string exchange — Required.

array loc_rdata — LOC records to attach to the Region Group.

string altitude — Required.
string horiz_pre — Required.
string latitude — Required.
string longitude — Required.
string size — Required.
string version — Required.
string vert_pre — Required.

array mx_rdata — MX records to attach to the Region Group.

string exchange — Required.
string preference — Required.

array naptr_rdata — NAPTR records to attach to the Region Group.

string order — Required.
string preference — Required.
string flags — Required.
string services — Required.
string regexp — Required.
string replacement — Required.

array nsap_rdata — NSAP records to attach to the Region Group.

string nsap — Required. Hex-encoded NSAP identifier

array ns_rdata — NS records to attach to the Region Group.

string nsdname — Required.

array ptr_rdata — PTR records to attach to the Region Group.

string ptrdname — Required.

array px_rdata — PX records to attach to the Region Group.

string preference — Required. numeric preference
string map822 — Required. mail hostname
string mapx400 — Required. X.400 address mapping

array rp_rdata — RP records to attach to the Region Group.

string mbox — Required.
string txtdname — Required.

array spf_rdata — SPF records to attach to the Region Group.

string txtdata — Required.

array srv_rdata — SRV records to attach to the Region Group.

string port — Required.
string priority — Required.
string target — Required.
string weight — Required.

array sshfp_rdata — SSHFP records to attach to the Region Group.

string algorithm — Required.
string fptype — Required.
string fingerprint — Required.

array txt_rdata — TXT records to attach to the Region Group.

string txtdata — Required.

array nodes — A list of zone, FQDN pairs in a hash that are to be linked to the Geo service.

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

Response — Click for More Info

SOAP Syntax

Click to view all SOAP Commands

CreateGeo — Create a new Geo Traffic Manager service on the zone/node indicated.

Arguments — Click for More Info

string name — Required. Name of the service. Must be unique.
string ttl — Time to Live for each record in the service.
array groups — Required. A list of region groups.

string name — Required. Name of the Region Group.
array countries — Required. A list of ISO-3166 two letter codes to represent the names of countries and their subdivisions or one of the predefined groups.
hash weight — Weight for each record that is entered.

array a_weight — Weight for each record that is entered.
array aaaa_weight — Weight for each record that is entered.
array cname_weight — Weight for each record that is entered.

hash serve_count — Serve count for each record.

string a_serve_count — Serve count for each record.
string aaaa_serve_count — Serve count for each record.

hash ttl — Time to Live for each record

string a_ttl — TTL for each A record
string aaaa_ttl — TTL count for each AAAA record
string cname_ttl — TTL count for each CNAME record
string cert_ttl — TTL count for each CERT record
string mx_ttl — TTL count for each MX record
string txt_ttl — TTL count for each TXT record
string spf_ttl — TTL count for each SPF record
string ptr_ttl — TTL count for each PTR record
string loc_ttl — TTL count for each LOC record
string srv_ttl — TTL count for each SRV record
string rp_ttl — TTL count for each RP record
string key_ttl — TTL count for each KEY record
string dnskey_ttl — TTL count for each DNSKEY record
string sshfp_ttl — TTL count for each SSHFP record
string dhcid_ttl — TTL count for each DHCID record
string nsap_ttl — TTL count for each NSAP record
string px_ttl — TTL count for each PX record

hash label — Label for each record

array a_label — Label for each A record
array aaaa_label — Label for each AAAA record
array cname_label — Label for each CNAME record
array cert_label — Label for each CERT record
array mx_label — Label for each MX record
array txt_label — Label for each TXT record
array spf_label — Label for each SPF record
array ptr_label — Label for each PTR record
array loc_label — Label for each LOC record
array srv_label — Label for each SRV record
array rp_label — Label for each RP record
array key_label — Label for each KEY record
array dnskey_label — Label for each DNSKEY record
array sshfp_label — Label for each SSHFP record
array dhcid_label — Label for each DHCID record
array nsap_label — Label for each NSAP record
array px_label — Label for each PX record

hash rdata — Required. The records to be served for the Region Group.

Note: Each element in the following rdata arrays is a hash containing the string elements that follow the rdata array.

array a_rdata — A records to attach to the Region Group.

string address — Required. IPv4 Address

array aaaa_rdata — AAAA records to attach to the Region Group.

string address — Required. IPv6 Address

array cert_rdata — CERT records to attach to the Region Group.

string format — Required.
string tag — Required.
string algorithm — Required.
string certificate — Required.

array cname_rdata — CNAME records to attach to the Region Group.

string cname — Required.Hostname

array dhcid_rdata — DHCID records to attach to the Region Group.

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

array dname_rdata — DNAME records to attach to the Region Group.

string dname — Required. Target hostname

array dnskey_rdata — DNSKEY records to attach to the Region Group.

string algorithm — Required.
string flags — Required.
string protocol — Required.
string public_key — Required.

array ds_rdata — DS records to attach to the Region Group.

string algorithm — Required.
string digest — Required.
string digtype — Required.
string keytag — Required.

array ipseckey_rdata — IPSECKEY records to attach to the Region Group.

string precedence — Required.
string gatetype — Required.
string algorithm — Required.
string gateway — Required.
string public_key — Required.

array key_rdata — KEY records to attach to the Region Group.

string algorithm — Required.
string flags — Required.
string protocol — Required.
string public_key — Required.

array kx_rdata — KX records to attach to the Region Group.

string preference — Required.
string exchange — Required.

array loc_rdata — LOC records to attach to the Region Group.

string altitude — Required.
string horiz_pre — Required.
string latitude — Required.
string longitude — Required.
string size — Required.
string version — Required.
string vert_pre — Required.

array mx_rdata — MX records to attach to the Region Group.

string exchange — Required.
string preference — Required.

array naptr_rdata — NAPTR records to attach to the Region Group.

string order — Required.
string preference — Required.
string flags — Required.
string services — Required.
string regexp — Required.
string replacement — Required.

array nsap_rdata — NSAP records to attach to the Region Group.

string nsap — Required. Hex-encoded NSAP identifier

array ns_rdata — NS records to attach to the Region Group.

string nsdname — Required.

array ptr_rdata — PTR records to attach to the Region Group.

string ptrdname — Required.

array px_rdata — PX records to attach to the Region Group.

string preference — Required. numeric preference
string map822 — Required. mail hostname
string mapx400 — Required. X.400 address mapping

array rp_rdata — RP records to attach to the Region Group.

string mbox — Required.
string txtdname — Required.

array spf_rdata — SPF records to attach to the Region Group.

string txtdata — Required.

array srv_rdata — SRV records to attach to the Region Group.

string port — Required.
string priority — Required.
string target — Required.
string weight — Required.

array sshfp_rdata — SSHFP records to attach to the Region Group.

string algorithm — Required.
string fptype — Required.
string fingerprint — Required.

array txt_rdata — TXT records to attach to the Region Group.

string txtdata — Required.

array nodes — A list of zone, FQDN pairs in a hash that are to be linked to the Geo service.

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

string token — Required. The session identifier.

Response — Click for More Info

Example Request — Click for More Info

{
	'name' => 'example Geo',
	'ttl'  => '3600', 		# Default TTL used if a record specific TTL does not exist
	'groups' => [{
			'name' => 'simplegroup',
			'countries' => ['US'],
			'rdata' => {
				'a_rdata' => [
					{ 'address' => '9.9.9.9',},
				],
			},
			'ttl' => {
				'a_ttl' => '900' # Record specific TTL, takes precedence over the service TTL
			}
	}],
	'nodes'	=> [{
		'zone'	=> 'example.com',
		'fqdn'  => 'admin.example.com',
	}]
	'token' => 'asdlj34ot879834cdzjklfK',
}

<< DNS API Knowledge Base

REST Syntax	Associated API Topics
SOAP Syntax	Update Geo Traffic Manager (classic) (API)
	Get Geo Traffic Manager (classic) (API)
	De-Activate Geo Traffic Manager (classic) (API)
	Delete Geo Traffic Manager (classic) (API)