v2

latestOpenAPI 3.0.02026-07-261859071.2 MB

Check status

Retrieve check status details

Show the current status information for a specific check.

get/v1/check-statuses/{checkId}

Path parameters

checkIdstring required

Headers

x-checkly-accountstring

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

namestring required

The name of the check.

checkIdstring

The ID of check this status belongs to.

hasFailuresboolean

Describes if this check is currently failing. If any of the assertions for an API checkfail this value is true. If a browser check fails for whatever reason, this is true.

hasErrorsboolean

Describes if due to some error outside of normal operation this check is failing. This should be extremely rare and only when there is an error in the Checkly backend.

isDegradedboolean

A check is degraded if it is over the degradation limit set by the "degradedResponseTime" field on the check. Applies only to API checks.

longestRunnumber nullable

The longest ever recorded response time for this check.

shortestRunnumber nullable

The shortest ever recorded response time for this check.

lastRunLocationstring nullable

What location this check was last run at.

lastCheckRunIdstring nullable

The unique incrementing ID for each check run.

sslDaysRemainingnumber nullable

How many days remain till the current SSL certificate expires.

created_atstring date

updated_atstring date-time nullable

Example response

{
  "name": "API Check",
  "checkId": "1008ca04-d3ca-41fa-b477-9e99b761dbb4",
  "isDegraded": true,
  "longestRun": 10,
  "shortestRun": 5,
  "lastRunLocation": "us-east-1",
  "lastCheckRunId": "f10d711f-cd16-4303-91ce-741c92586b4a",
  "sslDaysRemaining": 3
}