Fetching Locations and Instances

Refer to Instance Discovery overview to learn more about locations and instances.

The locations_response object

Attributes

The locations_response object

{
  "locations": [
    {
      "country_code": "text",
      "id": "text",
      "instance_count_max": 1,
      "instance_count_min": 1,
      "is_geolocated": true,
      "latitude": 1,
      "longitude": 1,
      "name": "text",
      "popularity_order": 1,
      "test_ips": [
        "text"
      ]
    }
  ]
}

Fetch list of locations

get

Authorizations

AuthorizationstringRequired

Uses the JWT Subscription Receipt Token

Query parameters

Header parameters

x-client-app-versionstringRequired

The app version of the client making the request.

Example: 8.10.123

x-client-device-modelstringRequired

The type of the device making the request

Example: ["desktop","mobile","tablet","firetv","appletv"]

x-client-osstringRequired

The operating system of the client making the request.

Example: ["windows","macos","linux","android","ios","web"]

x-client-os-versionstringRequired

The operating system version of the client making the request.

Example: 10.0.1234

x-sdk-versionstringRequired

The SDK version making the request

Example: 5.0.123

If-None-MatchstringOptional

ETag of the resource to be checked for modifications

Responses

200

Successful response containing list of locations

application/json

304

Not Modified - Resource has not changed

401

The Authorization Header is missing or invalid

409

Conflict occurs when the protocols query parameter specifies proxy and any other variant, as VPN protocols follow the Pecking Rules that does not support or contain proxy.

429

Rate limited

get

/ids2/locations

GET /ids2/locations HTTP/1.1
Host: <See Domain Reference>.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-client-app-version: text
x-client-device-model: ["desktop","mobile","tablet","firetv","appletv"]
x-client-os: ["windows","macos","linux","android","ios","web"]
x-client-os-version: text
x-sdk-version: text
Accept: */*

{
  "locations": [
    {
      "country_code": "text",
      "id": "text",
      "instance_count_max": 1,
      "instance_count_min": 1,
      "is_geolocated": true,
      "latitude": 1,
      "longitude": 1,
      "name": "text",
      "popularity_order": 1,
      "test_ips": [
        "text"
      ]
    }
  ]
}

Fetch list of endpoints for specified cluster

get