Retrieving one or all Geo Region Groups (classic) 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 use the ISO-3166 two letter codes for assigning countries to groups.
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/GeoRegionGroup/ GET — Retrieve one or all Geo Region Group(s).
HTTP Action — GET
URIs:
Get one Geo Region Group — https://api.dynect.net/REST/GeoRegionGroup/<service_name>/<group_name>/
Get all Geo Region Groups — https://api.dynect.net/REST/GeoRegionGroup/<service_name>/
|
| Arguments:
Get one Geo Region Group — No Arguments.
Get all Geo Region Groups —
string detail — a boolean indicating whether or not to return the full details or a list of service resources.
Y indicates all details for each service are specified.
N indicates only a list of service resources is returned. Default value.
|
| Response:
Get one Geo Region Group —
- string
name — Name of the Region Group.
- array
countries — List of ISO-3166 codes to represent the names of countries and their subdivisions.
- array
rdata — The RData to be served for the Region Group.
- string
service_name — The name of the service where the Region Group(s) exist.
Get all Geo Region Groups —
array — Individual Geo Region Group service resources.
|
SOAP Syntax
| Click to view all SOAP Commands |
|
GetOneGeoRegionGroup — Retrieves data from the Geo service for a single Region Group
GetGeoRegionGroups — Retrieves information about all the existing Region Groups for the specified Geo service.
|
| Arguments:
GetOneGeoRegionGroup —
- string
service_name — Required. Name of the Geo service where the Region Groups exist.
- string
name — Required. Name of the Region Group.
- string
token — Required. The session identifier.
GetGeoRegionGroups —
- string
service_name — Required. Name of the Geo service where the Region Groups exist.
- string
token — Required. The session identifier.
|
| Response:
GetOneGeoRegionGroup — Click for More Info
- hash
data
- hash
groups — A list of Region Group requested.
- string
name — Name of the Region Group
- array
countries — A list of ISO-3166 two letter codes to represent the names of countries and their subdivisions.
- array
rdata — The records 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 — Time to Live for each record
- array
label — Label for each record
- string
service_name — Geo service name where the Region Group exists.
GetGeoRegionGroups — Click for More Info
- array
data
- array
groups — A list of Region Group requested.
- string
name — Name of the Region Group
- array
countries — A list of ISO-3166 two letter codes to represent the names of countries and their subdivisions.
- array
rdata — The records 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 — Time to Live for each record
- array
label — Label for each record
- string
service_name — Geo service name where the Region Group exists.
|
Example Request (GetOneGeoRegionGroup) — Click for More Info
{
'service_name' => 'Example Geo',
'name' => 'Example Group',
'token' => 'asdlj34ot879834cdzjklfK'
}
|
Example Request (GetGeoRegionGroups) — Click for More Info
{
'service_name' => 'Example Geo',
'token' => 'asdlj34ot879834cdzjklfK'
}
|
DNS API Knowledge Base
