GET
/
v1
/
locations
Lists all supported locations
curl --request GET \
  --url https://api.checklyhq.com/v1/locations \
  --header 'Authorization: <api-key>'
[
  {
    "region": "us-east-1",
    "name": "N. Virginia"
  }
]

​
Overview

This endpoint returns all available monitoring locations where checks can be executed. This includes both public Checkly locations and your private locations.

​
Common Use Cases

Global Coverage Analysis

Analyze available locations for optimal global monitoring
GET /v1/locations?type=PUBLIC

Performance Optimization

Select closest locations to your users or services
GET /v1/locations?region=us-east-1

Private Network Monitoring

Find private locations for internal service monitoring
GET /v1/locations?type=PRIVATE

Location Selection Strategy

Compare latency and coverage across regions
GET /v1/locations?provider=AWS

​
Response Example

{
  "data": [
    {
      "id": "us-east-1",
      "name": "N. Virginia, USA",
      "region": "us-east-1",
      "type": "PUBLIC",
      "provider": "AWS",
      "availability": {
        "status": "ACTIVE",
        "uptime": 99.99,
        "lastUpdated": "2024-01-20T14:45:00.000Z"
      },
      "coordinates": {
        "latitude": 39.0458,
        "longitude": -77.5081
      },
      "capabilities": {
        "browserChecks": true,
        "apiChecks": true,
        "heartbeats": true,
        "multistepChecks": true
      },
      "performance": {
        "averageLatency": 45,
        "reliability": 99.98
      }
    },
    {
      "id": "eu-west-1",
      "name": "Ireland, Europe",
      "region": "eu-west-1",
      "type": "PUBLIC",
      "provider": "AWS",
      "availability": {
        "status": "ACTIVE",
        "uptime": 99.97,
        "lastUpdated": "2024-01-20T14:45:00.000Z"
      },
      "coordinates": {
        "latitude": 53.3498,
        "longitude": -6.2603
      },
      "capabilities": {
        "browserChecks": true,
        "apiChecks": true,
        "heartbeats": true,
        "multistepChecks": true
      },
      "performance": {
        "averageLatency": 52,
        "reliability": 99.96
      }
    },
    {
      "id": "ap-southeast-1",
      "name": "Singapore, Asia",
      "region": "ap-southeast-1",
      "type": "PUBLIC",
      "provider": "AWS",
      "availability": {
        "status": "ACTIVE",
        "uptime": 99.95,
        "lastUpdated": "2024-01-20T14:45:00.000Z"
      },
      "coordinates": {
        "latitude": 1.3521,
        "longitude": 103.8198
      },
      "capabilities": {
        "browserChecks": true,
        "apiChecks": true,
        "heartbeats": true,
        "multistepChecks": true
      },
      "performance": {
        "averageLatency": 38,
        "reliability": 99.94
      }
    },
    {
      "id": "pl_123456789",
      "name": "Production Data Center",
      "region": "us-east-1",
      "type": "PRIVATE",
      "provider": "PRIVATE",
      "availability": {
        "status": "ACTIVE",
        "uptime": 100.0,
        "lastUpdated": "2024-01-20T14:45:00.000Z"
      },
      "capabilities": {
        "browserChecks": true,
        "apiChecks": true,
        "heartbeats": true,
        "multistepChecks": false
      },
      "agentInfo": {
        "version": "1.2.3",
        "lastSeen": "2024-01-20T14:40:00.000Z",
        "checksCount": 25
      }
    }
  ],
  "meta": {
    "totalPublicLocations": 12,
    "totalPrivateLocations": 1,
    "totalItems": 13
  }
}

​
Location Types

Checkly-managed locations available to all users:
  • Global coverage across major regions
  • Maintained and updated by Checkly
  • High availability and reliability
  • No additional setup required
Customer-managed locations in your infrastructure:
  • Run checks from your own network
  • Monitor internal services
  • Custom geographic coverage
  • Requires Checkly Agent installation

​
Additional Examples

curl -X GET "https://api.checklyhq.com/v1/locations?type=PUBLIC&status=ACTIVE" \
  -H "Authorization: Bearer cu_1234567890abcdef" \
  -H "X-Checkly-Account: 550e8400-e29b-41d4-a716-446655440000"
Use this endpoint to get all available locations when configuring checks or check groups. Consider performance metrics and capabilities when selecting optimal locations for your monitoring strategy.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here.

Your API key is like a password: keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

​
region
string
required

The unique identifier of this location.

Example:

"us-east-1"

​
name
string
required

Friendly name of this location.

Example:

"N. Virginia"