87d29dc7b4fe
List all checks
Lists all current checks in your account.
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.
Query parameters
Limit the number of results
Limit the number of results
Page number
Page number
Filters the results by a string contained in the URL of an API check, for instance a domain like "www.myapp.com". Only returns API checks.
Filters the results by a string contained in the URL of an API check, for instance a domain like "www.myapp.com". Only returns API checks.
Filters checks by tags. Returns checks that have at least one of the specified tags.
Filters checks by tags. Returns checks that have at least one of the specified tags.
Filters checks by type. Returns checks that match the specified type.
Filters checks by type. Returns checks that match the specified type.
Filters checks by name using a case-insensitive partial match.
Filters checks by name using a case-insensitive partial match.
Filters checks by current status.
Filters checks by current status.
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
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
Example response
[
{
"projectBindings": {
"owner": {
"binding": {
"logicalId": "homepage-check"
}
},
"references": [
{
"binding": {
"logicalId": "homepage-check"
}
}
]
}
}
]