Sign in
Checks

Retrieve a check

Show details of a specific API or browser check

get/v1/checks/{id}

Path parameters

idstring uuid required

Query parameters

includeDependenciesboolean

Include check dependencies in the response

Include check dependencies in the response

applyGroupSettingsboolean

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

x-checkly-accountstring uuid

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

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "projectBindings": {
    "owner": {
      "binding": {
        "logicalId": "homepage-check"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check"
        }
      }
    ]
  }
}

Changes

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

  • 87d29dc7b4fe5314See the full diff
    • ▲

      for the path request parameter id, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • ▲

      for the header request parameter x-checkly-account, the type/format was changed from string/ to string/uuid

      request-parameter-type-changed

    • ▲

      for the path request parameter id, the type/format was changed from string/ to string/uuid

      request-parameter-type-changed

    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ▲

      removed the required property checkType from the response with the 200 status

      response-required-property-removed

    • ●

      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 id from the response with the 200 status

      response-optional-property-removed

    • ○

      added ChecksV1HeartbeatCheck ChecksV1PlaywrightCheck ChecksV1IcmpMonitor ChecksV1TracerouteMonitor ChecksV1GrpcMonitor ChecksV1SslMonitor ChecksV1ApiCheck ChecksV1TcpCheck ChecksV1UrlMonitor ChecksV1DnsMonitor ChecksV1BrowserCheck ChecksV1MultiStepCheck ChecksV1GenericCheck to the response body anyOf list for the response status 200

      response-body-any-of-added

    • ○

      added the non-success response with the status 400

      response-non-success-status-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 404

      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 404.00 enum value from the statusCode response property for the response status 404

      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 Not Found enum value from the error response property for the response status 404

      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