v2

latestOpenAPI 3.0.02026-07-261859071.2 MB

Checks

Retrieve a check

Show details of a specific API or browser check

get/v1/checks/{id}

Path parameters

idstring required

Query parameters

includeDependenciesboolean

Include check dependencies in the response

Include check dependencies in the response

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.