latestOpenAPI 3.0.02026-08-121915501.4 MB

87d29dc7b4fe

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"
        }
      }
    ]
  }
}