Retrieve a check
Show details of a specific API or browser check
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 project that manages this check, or null when the check is not managed by code. When a check has more than one binding, this reports the preferred one.
The check's logical ID within the managing project, or null when it is not managed by code.
True when the project owns this check, false when it merely references a check owned outside the project. Null when not managed by code. The same relationship appears structurally in projectBindings: an owning project under projectBindings.owner, a referencing one under projectBindings.references.
True when the binding is reserved by an import plan that has not been deployed yet. Null when not managed by code.
The Checkly CLI projects that manage this resource. owner is null and references empty when the resource is not managed by code.
1HEARTBEAT