List check locations. `live` ones can go in `check_regions`; `draining` and `retired` ones label older results.

GET

/check-locations

const url = 'https://api.siteqwality.com/check-locations';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://api.siteqwality.com/check-locations \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Responses

200

Locations and the default

application/json

object

default_location_id

required

string

locations

required

Array<object>

A check location as an account sees it (GET /check-locations).

object

required

Stable id, <provider>-<region>, used in a monitor’s check_regions.

string

provider

required

string

Allowed values: aws gcp azure

provider_name

required

AWS, Google Cloud or Azure.

string

provider_region

required

string

city

required

string

country_code

required

ISO 3166-1 alpha-2.

string

continent

required

string

label

required

"{city} · {provider_name}".

string

status

required

string

Allowed values: hidden live draining retired

is_default

required

Where checks run when a monitor selects no location.

boolean

capabilities

required

Monitor types the location runs: http, browser.

Array<string>

Example

{
  "locations": [
    {
      "provider": "aws",
      "status": "hidden"
    }
  ]
}

401

Missing or invalid authentication

500

Internal server error