Retrieve one check in a specific group with group settings applied

Show details of one check in a specific check group with the group settings applied.

GET /v1/check-groups/{groupId}/checks/{checkId}

Retrieve one check in a specific group with group settings applied

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/check-groups/{groupId}/checks/{checkId} \
  --header 'Authorization: Bearer <token>'

200

{
  "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

groupId · integer · required

checkId · string · required

Response

200

application/json

Successful

checkType · enum<string> · required

The type of the check.

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

id · string