87d29dc7b4fe

latestOpenAPI 3.0.02026-08-121915501.4 MB
Checks

Create an API check

Creates a new API check. Will return a 402 when you are over the limit of your plan. When using the globalAlertSetting, the alertSetting can be null

post/v1/checks/api

Query parameters

autoAssignAlertsboolean

Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.

Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.

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

Request body

namestring required
activatedboolean
mutedboolean
doubleCheckboolean
shouldFailboolean
locationsstring[] nullable
tagsstring[]
useGlobalAlertSettingsboolean
groupIdnumber nullable
groupOrdernumber nullable
runtimeId'2026.04' | '2025.04' | '2024.09' | '2024.02' | '2023.09' | '2023.02' | '2022.10' | 'null' nullable
runParallelboolean
descriptionstring nullable
checkType'API'
frequency0 | 1 | 2 | 5 | 10 | 15 | 30 | 60 | 120 | 180 | 360 | 720 | 1440
frequencyOffsetinteger
degradedResponseTimenumber nullable
maxResponseTimenumber nullable
privateLocationsstring[] nullable
tearDownSnippetIdnumber nullable
setupSnippetIdnumber nullable
localSetupScriptstring nullable
localTearDownScriptstring nullable

Response

Created

namestring required
activatedboolean
mutedboolean
doubleCheckboolean
shouldFailboolean
locationsstring[] nullable
tagsstring[]
useGlobalAlertSettingsboolean
groupIdnumber nullable
groupOrdernumber nullable
runtimeId'2026.04' | '2025.04' | '2024.09' | '2024.02' | '2023.09' | '2023.02' | '2022.10' | 'null' nullable
runParallelboolean
descriptionstring nullable
idstring
created_atstring date-time
updated_atstring date-time nullable
privateLocationsstring[] nullable
frequency0 | 1 | 2 | 5 | 10 | 15 | 30 | 60 | 120 | 180 | 360 | 720 | 1440
frequencyOffsetinteger
degradedResponseTimenumber nullable
maxResponseTimenumber nullable
checkType'API'
tearDownSnippetIdnumber nullable
setupSnippetIdnumber nullable
localSetupScriptstring nullable
localTearDownScriptstring nullable