Retrieve a check (v2)
Show details of a specific API or browser check.
Unlike /v1, this endpoint does not return the flat project, logicalId, member and pending fields. A check can be managed by more than one project and each of those fields can name only one of them; projectBindings reports every binding, and is identical on /v1 and /v2.
Versioning is per endpoint. Only endpoints whose response or payload changed have a /v2; everything else remains on /v1 and is unaffected. In particular the check groups themselves, and creating, updating and deleting checks, are unchanged and stay on /v1.
Authorizations
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
Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
Path Parameters
1Query Parameters
Include check dependencies in the response
Checks that belong to a group are returned with group settings applied.
Response
Successful
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
1us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, sa-east-1, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, me-south-1, ap-southeast-1, ap-northeast-1, ap-east-1, ap-southeast-2, ap-southeast-3, ap-northeast-2, ap-northeast-3, ap-south-1, af-south-1 1x >= 0500The Checkly CLI projects that manage this resource. owner is null and references empty when the resource is not managed by code.
1HEARTBEAT