Accounts11

Alert channels6

Alert notifications1

Analytics12

Badges2

Check alerts2

Check groups11

Check results4

Check sessions7

Check status2

Checks16

Client certificates4

Dashboards5

Deployment Triggers2

Environment variables5

Error Groups4

Heartbeats5

Incident Updates3

Incidents4

Location1

Maintenance windows12

Monitors7

Private locations8

Reporting1

Rocky AI3

Runtimes2

Snippets5

Static IPs6

Status Page Incidents10

Status Page Services5

Status Pages8

Test Session Error Groups4

Test sessions7

Triggers6

Checks

List all checks

Lists all current checks in your account.

get/v1/checks

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.

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"
        }
      },
      "references": [
        {
          "binding": {
            "logicalId": "homepage-check"
          }
        }
      ]
    }
  }
]

Changes

Changed in 1 of the 4 revisions of this API.3511

Aug 12, 202687d29dc7b4fe3511See the full diff
- ▲
  for the header request parameter x-checkly-account, the type/format was changed from string/ to string/uuid
  request-parameter-type-changed
- ▲
  the items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property items/checkType from the response with the 200 status
  response-required-property-removed
- ●
  for the query request parameter page, the exclusiveMinimum was set to true
  request-parameter-exclusive-min-set
- ●
  for the query request parameter page, the min was set to 0.00
  request-parameter-min-set
- ●
  removed the optional property attributes from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property attributes from the response with the 429 status
  response-optional-property-removed
- ●
  removed the optional property items/id from the response with the 200 status
  response-optional-property-removed
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added ChecksV1HeartbeatCheck ChecksV1PlaywrightCheck ChecksV1IcmpMonitor ChecksV1TracerouteMonitor ChecksV1GrpcMonitor ChecksV1SslMonitor ChecksV1ApiCheck ChecksV1TcpCheck ChecksV1UrlMonitor ChecksV1DnsMonitor ChecksV1BrowserCheck ChecksV1MultiStepCheck ChecksV1GenericCheck to the items/ response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  the response property message became required for the status 401
  response-property-became-required
- ○
  the response property message became required for the status 403
  response-property-became-required
- ○
  the response property message became required for the status 429
  response-property-became-required
- ○
  removed the 401.00 enum value from the statusCode response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the 403.00 enum value from the statusCode response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the 429.00 enum value from the statusCode response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the Forbidden enum value from the error response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the Too Many Requests enum value from the error response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the Unauthorized enum value from the error response property for the response status 401
  response-property-enum-value-removed
This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history