CHchecklyhq
Checks

Create a multi-step check

Changed on

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

Request

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
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
aiAutoRepairEnabledboolean 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",
        "sourceFile": "src/__checks__/homepage.check.ts"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check",
          "sourceFile": "src/__checks__/homepage.check.ts"
        }
      }
    ]
  }
}

Changes

  • bc90d1bfa738Revision 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

  • aba5d34c749bRevision changes
    • 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