Retrieving one or all Geo Traffic Manager (classic) service 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.
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.
In order for monitoring to occur on your account, please make sure the IP addresses included here (https://manage.dynect.net/help/agents.html) can reach all your network endpoints. The web page requires you to log-on to Dyn’s Managed DNS.
Understanding How The API Works »
| 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 service to your zone. All other users should use Traffic Director instead. |
REST Syntax
| Click to view all REST Resources |
|
REST/Geo/ GET — Retrieves information for one or all Geo Traffic Manager resources from the zone or node indicated.
HTTP Action — GET
URIs:
Get one Geo Traffic Manager — https://api.dynect.net/REST/Geo/<service_name>/
Get all Geo Traffic Managers — https://api.dynect.net/REST/Geo/
|
| Arguments:
Get one Geo Traffic Manager service: No Arguments.
Get all Geo Traffic Managers:
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 — (default) The list of service resources is returned.
|
| Response:
Get one Geo Traffic Manager — Click for More Info
- array Individual Geo service resource in an array
- string
name — Name of the Geo service.
- string
active — Indicates if the service is active.
Valid values:
Y — The service is active.
N — The service is inactive.
- array
groups — A list of Region Groups that are defined for the service.
- string
name — Name of the Region Group
- array
countries — A list ISO-3166 codes to represent the names of countries and their subdivisions.
- array
rdata — The RData to be served for the Region Group.
- array
nodes — A list of zone and FQDN pairs to identify nodes that are attached to the Geo service.
- string
fqdn — Fully qualified domain name of a node in the zone.
- string
zone — Name of the zone
Get all Geo Traffic Manager services: array — Individual Geo Traffic Manager services.
|
SOAP Syntax
| Click to view all SOAP Commands |
|
GetOneGeo — Retrieve a single entry from a Geo Traffic Manager service.
GetGeos — Retrieve all entries from a Geo Traffic Manager service resources.
|
| Arguments:
GetOneGeo:
- string
name — Required. Name of the service.
- string
token — Required. The session identifier.
GetGeos:
- string
token — Required. The session identifier
|
| Response:
GetOneGeo — Click for More Info
- hash
data
- string
name — Name of the Geo service.
- string
active — Y if the service is active. N if the service is inactive.
- array
groups — A list of Region Groups that are defined for the service.
- string
name — Name of the Region Group.
- array
countries — A list ISO-3166 codes to represent the names of countries and their subdivisions.
- array
rdata — The RData to be served for the Region Group.
- hash
weight — Weight for each record that is entered.
- hash
serve_count — Serve count for each record.
- string
ttl — TTL for each record.
- array
label — Label for each record.
- array
nodes — A list of zone and FQDN pairs to identify nodes that are attached to the Geo service.
- string
fqdn — Name of the node where the service exists.
- string
zone — Name of the zone where the service exists.
GetGeos — Click for More Info
- array
data
- string
name — Name of the Geo service.
- string
active — Y if the service is active. N if the service is inactive.
- array
groups — A list of Region Groups that are defined for the service.
- string
name — Name of the Region Group.
- array
countries — A list ISO-3166 codes to represent the names of countries and their subdivisions.
- array
rdata — The RData to be served for the Region Group.
- hash
weight — Weight for each record that is entered.
- hash
serve_count — Serve count for each record.
- string
ttl — TTL for each record.
- array
label — Label for each record.
- array
nodes — A list of zone and FQDN pairs to identify nodes that are attached to the Geo service.
- string
fqdn — Name of the node where the service exists.
- string
zone — Name of the zone where the service exists.
|
Example Request (GetOneGeo) — Click for More Info
{
'name' => 'Example Geo'
'token' => 'asdlj34ot879834cdzjklfK',
}
|
Example Request (GetGeos) — Click for More Info
{
'token' => 'asdlj34ot879834cdzjklfK',
}
|
DNS API Knowledge Base
