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 multi-step check

Creates a new Multi-Step 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/multistep

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

checkType'MULTI_STEP'

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

scriptstring nullable required

scriptPathstring nullable

privateLocationsstring[] 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

logicalIdstring nullable

The check's logical ID within the managing project, or null when it is not managed by code.

memberboolean nullable

True when the project owns this check, false when it merely references a check owned outside the project. Null when not managed by code. The same relationship appears structurally in projectBindings: an owning project under projectBindings.owner, a referencing one under projectBindings.references.

pendingboolean nullable

True when the binding is reserved by an import plan that has not been deployed yet. Null when not managed by code.

privateLocationsstring[] nullable

checkType'MULTI_STEP'

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

scriptstring nullable required

Example response

{
  "projectBindings": {
    "owner": {
      "binding": {
        "logicalId": "homepage-check"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check"
        }
      }
    ]
  }
}

Changes

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

Aug 12, 202687d29dc7b4fe23437See 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
- ▲
  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 script 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 triggerIncident/serviceId request property type/format changed from string/ to string/uuid
  request-property-type-changed
- ▲
  the response property environmentVariables/items/value became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property alertChannels/email/items/address became optional for the status 201
  response-property-became-optional
- ▲
  the response property alertChannels/slack/items/url became optional for the status 201
  response-property-became-optional
- ▲
  the response property alertChannels/sms/items/number became optional for the status 201
  response-property-became-optional
- ▲
  the response property alertChannels/webhook/items/url became optional for the status 201
  response-property-became-optional
- ▲
  the created_at response's property type/format changed from string/date to string/date-time for status 201
  response-property-type-changed
- ●
  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
- ●
  added the new undefined enum value to the runtimeId response property for the response status 201
  response-property-enum-value-added
- ○
  the request property environmentVariables/items/value became nullable
  request-property-became-nullable
- ○
  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 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 the non-success response with the status 400
  response-non-success-status-added
- ○
  added the optional property logicalId to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property member to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property pending to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property project to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property projectBindings to the response with the 201 status
  response-optional-property-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
- ○
  the headers response's property default value was added for the status 201
  response-property-default-value-added
- ○
  the locations response's property default value was added for the status 201
  response-property-default-value-added
- ○
  the queryParameters response's property default value was added for the status 201
  response-property-default-value-added
- ○
  the tags response's property default value was added for the status 201
  response-property-default-value-added
- ○
  the activated response's property default value true was removed for the status 201
  response-property-default-value-removed
- ○
  the value response's property default value was removed for the status 201
  response-property-default-value-removed
- ○
  the value response's property default value was removed for the status 201
  response-property-default-value-removed
- ○
  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 DELETE enum value from the alertChannels/webhook/items/method response property for the response status 201
  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 GET enum value from the alertChannels/webhook/items/method response property for the response status 201
  response-property-enum-value-removed
- ○
  removed the HEAD enum value from the alertChannels/webhook/items/method response property for the response status 201
  response-property-enum-value-removed
- ○
  removed the PATCH enum value from the alertChannels/webhook/items/method response property for the response status 201
  response-property-enum-value-removed
- ○
  removed the POST enum value from the alertChannels/webhook/items/method response property for the response status 201
  response-property-enum-value-removed
- ○
  removed the PUT enum value from the alertChannels/webhook/items/method response property for the response status 201
  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