Accounts11

Alert channels6

Alert notifications1

Analytics12

Badges2

Check alerts2

Check groups11

Check results4

Check sessions7

Check status2

Checks16

Client certificates4

Dashboards5

Deployment Triggers2

Environment variables5

Error Groups4

Heartbeats5

Incident Updates3

Incidents4

Location1

Maintenance windows12

Monitors7

Private locations8

Reporting1

Rocky AI3

Runtimes2

Snippets5

Static IPs6

Status Page Incidents10

Status Page Services5

Status Pages8

Test Session Error Groups4

Test sessions7

Triggers6

Checks

Create a check

[DEPRECATED] This endpoint will be removed soon. Instead use POST /checks/api or POST /checks/browser. 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

post/v1/checks

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

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"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check"
        }
      }
    ]
  }
}

Changes

Changed in 1 of the 4 revisions of this API.21441

Aug 12, 202687d29dc7b4fe21441See the full diff
- ▲
  request body became required
  request-body-became-required
- ▲
  for the header request parameter x-checkly-account, the type/format was changed from string/ to string/uuid
  request-parameter-type-changed
- ▲
  request property frequency was restricted to a list of enum values
  request-property-became-enum
- ▲
  the dependencies/items/content request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the dependencies/items/path request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the environmentVariables/items/key request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the name request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the privateLocations/items/ request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the scriptPath request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the tags/items/ request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the triggerIncident/serviceId request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the alertSettings/parallelRunFailureThreshold/percentage request property type/format changed from number/ to integer/
  request-property-type-changed
- ▲
  the alertSettings/reminders/amount request property type/format changed from number/ to integer/
  request-property-type-changed
- ▲
  the alertSettings/reminders/interval request property type/format changed from number/ to integer/
  request-property-type-changed
- ▲
  the alertSettings/runBasedEscalation/failedRunThreshold request property type/format changed from number/ to integer/
  request-property-type-changed
- ▲
  the alertSettings/timeBasedEscalation/minutesFailingThreshold request property type/format changed from number/ to integer/
  request-property-type-changed
- ▲
  the degradedResponseTime request property type/format changed from / to number/
  request-property-type-changed
- ▲
  the maxResponseTime request property type/format changed from / to number/
  request-property-type-changed
- ▲
  the triggerIncident/serviceId request property type/format changed from string/ to string/uuid
  request-property-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 201
  response-body-type-changed
- ▲
  removed the required property checkType from the response with the 201 status
  response-required-property-removed
- ●
  removed the optional property attributes from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property attributes from the response with the 402 status
  response-optional-property-removed
- ●
  removed the optional property attributes from the response with the 429 status
  response-optional-property-removed
- ●
  removed the optional property id from the response with the 201 status
  response-optional-property-removed
- ○
  the request property degradedResponseTime became nullable
  request-property-became-nullable
- ○
  the request property environmentVariables/items/value became nullable
  request-property-became-nullable
- ○
  the request property heartbeat became nullable
  request-property-became-nullable
- ○
  the request property maxResponseTime became nullable
  request-property-became-nullable
- ○
  the request property script became nullable
  request-property-became-nullable
- ○
  the request property sslCheckDomain became nullable
  request-property-became-nullable
- ○
  the request property heartbeat became optional
  request-property-became-optional
- ○
  the request property script became optional
  request-property-became-optional
- ○
  the locations request property default value was added
  request-property-default-value-added
- ○
  the tags request property default value was added
  request-property-default-value-added
- ○
  the activated request property default value true was removed
  request-property-default-value-removed
- ○
  added the new 0.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 1.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 10.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 120.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 1440.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 15.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 180.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 2.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 30.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 360.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 5.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 60.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new 720.00 enum value to the request property frequency
  request-property-enum-value-added
- ○
  added the new undefined enum value to the request property runtimeId
  request-property-enum-value-added
- ○
  the description request property's maxLength was increased from 500 to 510
  request-property-max-length-increased
- ○
  added ChecksV1ApiRequest ChecksV1TcpRequest ChecksV1UrlRequest ChecksV1DnsRequest ChecksV1IcmpRequest ChecksV1TracerouteRequest ChecksV1GrpcRequest ChecksV1SslRequest to the request request property oneOf list
  request-property-one-of-added
- ○
  added ChecksV1HeartbeatCheck ChecksV1PlaywrightCheck ChecksV1IcmpMonitor ChecksV1TracerouteMonitor ChecksV1GrpcMonitor ChecksV1SslMonitor ChecksV1ApiCheck ChecksV1TcpCheck ChecksV1UrlMonitor ChecksV1DnsMonitor ChecksV1BrowserCheck ChecksV1MultiStepCheck ChecksV1GenericCheck to the response body anyOf list for the response status 201
  response-body-any-of-added
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  the response property message became required for the status 401
  response-property-became-required
- ○
  the response property message became required for the status 402
  response-property-became-required
- ○
  the response property message became required for the status 403
  response-property-became-required
- ○
  the response property message became required for the status 429
  response-property-became-required
- ○
  removed the 401.00 enum value from the statusCode response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the 402.00 enum value from the statusCode response property for the response status 402
  response-property-enum-value-removed
- ○
  removed the 403.00 enum value from the statusCode response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the 429.00 enum value from the statusCode response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the Forbidden enum value from the error response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the Payment Required enum value from the error response property for the response status 402
  response-property-enum-value-removed
- ○
  removed the Too Many Requests enum value from the error response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the Unauthorized enum value from the error response property for the response status 401
  response-property-enum-value-removed
This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history