Retrieve a check

Show details of a specific API or browser check

GET /v1/checks/{id}

Try it

Retrieve a check

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/checks/{id} \
  --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

Path Parameters

id · string · required

Query Parameters

includeDependencies · boolean

Include check dependencies in the response

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