v2

latestOpenAPI 3.0.02026-07-261859071.2 MB

Checks

List all checks

Lists all current checks in your account.

get/v1/checks

Query parameters

limitinteger

Limit the number of results

Limit the number of results

pagenumber

Page number

Page number

apiCheckUrlFilterPatternstring

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.

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.

tagstring[]

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

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

checkType'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'TRACEROUTE' | 'URL' | 'DNS' | 'SSL' | 'GRPC'

Filters checks by type. Returns checks that match the specified type.

Filters checks by type. Returns checks that match the specified type.

searchstring

Filters checks by name using a case-insensitive partial match.

Filters checks by name using a case-insensitive partial match.

status'passing' | 'failing' | 'degraded'

Filters checks by current status.

Filters checks by current status.

applyGroupSettingsboolean

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

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

Headers

x-checkly-accountstring

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

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

Response

Successful

idstring

checkType'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'TRACEROUTE' | 'URL' | 'DNS' | 'SSL' | 'GRPC' required

The type of the check.