List regions

GET

/regions

const url = 'https://app.tunnelhq.com/api/v1/regions';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.tunnelhq.com/api/v1/regions

The locations you can test from right now, with how many checkers each has. No key needed. any is the general pool; a country code tests from that country, on the Pro plan and above.

Responses

200

The locations.

application/json

Array<object>

object

region

required

any, or a lowercase country code to use as region.

string

regionName

required

string

physical

required

true when TunnelHQ has checkers there; false when tests go through a residential relay.

boolean

healthyCount

required

Checkers (or relays) working now.

integer

totalCount

required

integer

residentialAvailable

Present only on relay locations.

boolean

Example

[
  {
    "region": "any",
    "regionName": "Any region (general pool)",
    "physical": true,
    "healthyCount": 4,
    "totalCount": 4
  },
  {
    "region": "pk",
    "regionName": "Pakistan (South Asia)",
    "physical": true,
    "healthyCount": 1,
    "totalCount": 1
  }
]