GET
/
v1
/
checks
/
{id}
Retrieve a check
curl --request GET \
  --url https://api.checklyhq.com/v1/checks/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "checkType": "API"
}

​
Overview

The Get Check endpoint retrieves comprehensive details about a specific check, including its configuration, script content, environment variables, and execution settings. Common Use Cases:
  • Check Configuration Review
  • Script Content Retrieval
  • Settings Verification
  • Check Management
This endpoint returns complete check details including sensitive information like environment variables. Ensure proper access controls when exposing this data.

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

​
id
string
required

Query Parameters

​
includeDependencies
boolean

Include check dependencies in the response

​
applyGroupSettings
boolean
default:false

Checks that belong to a group are returned with group settings applied.

Response

Successful

​
checkType
enum<string>
required

The type of the check.

Available options:
API,
BROWSER,
HEARTBEAT,
MULTI_STEP,
TCP,
PLAYWRIGHT,
URL
​
id
string