Accounts11

Alert channels6

Alert notifications1

Analytics12

Badges2

Check alerts2

Check groups11

Check results4

Check sessions7

Check status2

Checks15

Client certificates4

Dashboards5

Deployment Triggers2

Elements2

Environment variables5

Error Groups4

Heartbeats5

Incident Updates3

Incidents4

Location1

Maintenance windows12

Monitors14

Private locations8

Reporting1

Rocky AI3

Runtimes2

Secret scans1

Snippets5

Static IPs6

Status Page Incidents10

Status Page Services5

Status Pages8

Status Pages V37

Status Pages V3 Automation Rules5

Status Pages V3 Components5

Status Pages V3 Incidents11

Status Pages V3 Subscribers3

Test Session Error Groups4

Test sessions7

Triggers6

Usage8

Checks

Create a check

Changed on Oct 31, 2026

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

Use POST /v1/checks/api or POST /v1/checks/browser for new integrations.

post/v1/checks

Request

Base URL
https://api.checklyhq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/checklyhq/apis/checkly-public-api/docs/v1/checks/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

autoAssignAlertsboolean

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

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

aiAutoRepairEnabledboolean nullable

frequency0 | 1 | 2 | 5 | 10 | 15 | 30 | 60 | 120 | 180 | 360 | 720 | 1440

frequencyOffsetinteger

heartbeatobject nullable

scriptstring nullable

scriptPathstring nullable

sslCheckDomainstring nullable

setupSnippetIdnumber nullable

tearDownSnippetIdnumber nullable

localSetupScriptstring nullable

localTearDownScriptstring nullable

degradedResponseTimenumber nullable

maxResponseTimenumber nullable

privateLocationsstring[] nullable

Response

Created

Example response

{
  "projectBindings": {
    "owner": {
      "binding": {
        "logicalId": "homepage-check",
        "sourceFile": "src/__checks__/homepage.check.ts"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check",
          "sourceFile": "src/__checks__/homepage.check.ts"
        }
      }
    ]
  }
}

Changes

Oct 31, 2026bc90d1bfa738 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Oct 7, 2026aba5d34c749b Revision changes
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  the //// request property type changed from no type to object
- breaking
  the //// request property type changed from no type to object
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status

Operation history (4 revisions)