GET
/
v1
/
check-statuses
/
{checkId}
Retrieve check status details
curl --request GET \
  --url https://api.checklyhq.com/v1/check-statuses/{checkId} \
  --header 'Authorization: <api-key>'
{
  "name": "API Check",
  "checkId": "1008ca04-d3ca-41fa-b477-9e99b761dbb4",
  "hasFailures": false,
  "hasErrors": false,
  "isDegraded": true,
  "longestRun": 10,
  "shortestRun": 5,
  "lastRunLocation": "us-east-1",
  "lastCheckRunId": "f10d711f-cd16-4303-91ce-741c92586b4a",
  "sslDaysRemaining": 3,
  "created_at": "2023-12-25",
  "updated_at": "2023-11-07T05:31:56Z"
}

​
Overview

The Get Check Status endpoint retrieves the current health status of a specific check, including its last execution status, response times, and availability information. Common Use Cases:
  • Individual Check Health Monitoring
  • Status Dashboard Integration
  • Real-time Status Verification
  • Check-specific Status Reporting
This endpoint provides real-time status information for a specific check, including current health state, last execution details, and recent performance metrics.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here.

Your API key is like a password: keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

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

Path Parameters

​
checkId
string
required

Response

Successful

​
name
string
required

The name of the check.

Example:

"API Check"

​
checkId
string

The ID of check this status belongs to.

Example:

"1008ca04-d3ca-41fa-b477-9e99b761dbb4"

​
hasFailures
boolean

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.

Example:

false

​
hasErrors
boolean

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.

Example:

false

​
isDegraded
boolean

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

Example:

true

​
longestRun
number

The longest ever recorded response time for this check.

Example:

10

​
shortestRun
number

The shortest ever recorded response time for this check.

Example:

5

​
lastRunLocation
string

What location this check was last run at.

Example:

"us-east-1"

​
lastCheckRunId
string

The unique incrementing ID for each check run.

Example:

"f10d711f-cd16-4303-91ce-741c92586b4a"

​
sslDaysRemaining
number

How many days remain till the current SSL certificate expires.

Example:

3

​
created_at
string<date>
​
updated_at
string<date-time>