Skip to main content
GET
/
v1
/
checks
List all checks
curl --request GET \
  --url https://api.checklyhq.com/v1/checks \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "checkType": "API"
  }
]

​
Overview

The List Checks endpoint returns all monitoring checks (browser checks, API checks, and heartbeat checks) configured in your Checkly account. Use this endpoint to get an overview of your monitoring setup or to programmatically manage your checks.
This endpoint returns both active and paused checks. Use the activated field in the response to determine the current status of each check.

​
Common Use Cases

Monitor All Active Checks

Get all currently running checks to verify your monitoring coverage
GET /v1/checks?activated=true

Filter by Environment

Use tags to filter checks by environment or criticality
GET /v1/checks?tags=production,critical

Check Type Analysis

Analyze your monitoring setup by check types
GET /v1/checks?checkType=BROWSER

Audit Inactive Checks

Find paused checks that might need attention
GET /v1/checks?activated=false

​
Response Example

{
  "checks": [
    {
      "id": "73208bf5-2b42-4ab3-b18c-7ac505b7d7b4",
      "name": "Homepage Load Test",
      "checkType": "BROWSER",
      "frequency": 5,
      "activated": true,
      "muted": false,
      "shouldFail": false,
      "locations": ["us-east-1", "eu-west-1", "ap-southeast-1"],
      "tags": ["production", "critical", "homepage"],
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-20T14:45:00.000Z",
      "script": "// Playwright browser check script\nconst { test, expect } = require('@playwright/test');\n\ntest('Homepage loads successfully', async ({ page }) => {\n  await page.goto('https://example.com');\n  await expect(page).toHaveTitle(/Example/);\n});",
      "environmentVariables": [
        {
          "key": "BASE_URL",
          "value": "https://example.com",
          "locked": false
        }
      ]
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "API Health Check",
      "checkType": "API",
      "frequency": 2,
      "activated": true,
      "muted": false,
      "shouldFail": false,
      "locations": ["us-east-1", "eu-west-1"],
      "tags": ["production", "api", "health"],
      "createdAt": "2024-01-10T08:15:00.000Z",
      "updatedAt": "2024-01-18T16:20:00.000Z",
      "script": "// API check script\nconst response = await fetch('https://api.example.com/health');\nexpect(response.status).toBe(200);",
      "environmentVariables": []
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 100,
    "totalPages": 1,
    "totalItems": 2
  }
}

​
Additional Examples

curl -X GET "https://api.checklyhq.com/v1/checks?checkType=BROWSER&activated=true" \
  -H "Authorization: Bearer cu_1234567890abcdef" \
  -H "X-Checkly-Account: 550e8400-e29b-41d4-a716-446655440000"
The checks returned by this endpoint include all check types in your account. Use the checkType filter to focus on specific monitoring types, or the tags parameter to filter by your organizational structure.

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

Query Parameters

​
limit
integer
default:10

Limit the number of results

Required range: 1 <= x <= 100
​
page
number
default:1

Page number

​
apiCheckUrlFilterPattern
string

Filters the results by a string contained in the URL of an API check, for instance a domain like "www.myapp.com". Only returns API checks.

Minimum length: 1
​
tag
string[]

Filters checks by tags. Returns checks that have at least one of the specified tags.

​
applyGroupSettings
boolean
default:false

Checks that belong to a group are returned with group settings applied.

Response

Successful

​
checkType
enum<string>
required

The type of the check.

Available options:
API,
BROWSER,
HEARTBEAT,
MULTI_STEP,
TCP,
PLAYWRIGHT,
URL,
DNS
​
id
string
⌘I