CHchecklyhq
Checks

List all checks

Changed on

Lists all current checks in your account.

This /v3 read returns check intent as a constraints array with typed REQUIRED_OUTCOME and MUST_PRESERVE entries. /v1 and /v2 keep the legacy requiredOutcomes and mustPreserve arrays. Like /v2, /v3 does not return the flat project, logicalId, member and pending fields; use projectBindings for the complete project ownership state. Creating, updating and deleting checks remain on /v1.

get/v3/checks

Request

Query parameters

limitinteger

Limit the number of results

pagenumber

Page number

apiCheckUrlFilterPatternstring

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.

tagstring[]

Filters checks by tags. Returns checks that have at least one of the specified tags.

checkType'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'TRACEROUTE' | 'URL' | 'DNS' | 'SSL' | 'GRPC'

Filters checks by type. Returns checks that match the specified type.

searchstring

Filters checks by name using a case-insensitive partial match.

status'passing' | 'failing' | 'degraded'

Filters checks by current status.

applyGroupSettingsboolean

Checks that belong to a group are returned with group settings applied.

Headers

x-checkly-accountstring uuid

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",
          "sourceFile": "src/__checks__/homepage.check.ts"
        }
      },
      "references": [
        {
          "binding": {
            "logicalId": "homepage-check",
            "sourceFile": "src/__checks__/homepage.check.ts"
          }
        }
      ]
    }
  }
]

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • aba5d34c749bRevision changes
    • info

      endpoint added