List all checks

Lists all current checks in your account.

GET /v1/checks

Try it

List all checks

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/checks \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "checkType": "API",
    "id": "<string>"
  }
]

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 string 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

200

application/json

Successful

checkType · enum<string> · required

The type of the check.

Available options: API, BROWSER, HEARTBEAT, MULTI_STEP, TCP, PLAYWRIGHT, URL, DNS

id · string