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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to true

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

Body Params
string
required

The name of the check.

boolean
Defaults to true

Determines if the check is running or not.

boolean
Defaults to false

Determines if any notifications will be send out when a check fails and/or recovers.

boolean
Defaults to true

[Deprecated] Retry failed check runs. This property is deprecated, and retryStrategy can be used instead.

boolean
Defaults to false

Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

locations
array of objects

An array of one or more data center locations where to run this check.

locations
tags
array of strings

Tags for organizing and filtering checks.

tags
alertSettings
object

Alert settings.

boolean
Defaults to true

When true, the account level alert setting will be used, not the alert setting defined on this check.

number
Defaults to null

The id of the check group this check is part of.

number
≥ 0
Defaults to null

The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

string
enum
Defaults to null

The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.

Allowed:
alertChannelSubscriptions
array of objects

List of alert channel subscriptions.

alertChannelSubscriptions
retryStrategy
object

The strategy to determine how failed checks are retried.

triggerIncident
object

Determines whether the check or monitor should create and resolve an incident based on its alert configuration. Useful for status page automation.

boolean
Defaults to false

When true, the check will run in parallel in all selected locations.

string
enum
Defaults to MULTI_STEP
Allowed:
environmentVariables
array of objects
length ≤ 50

Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.

environmentVariables
integer
enum
Defaults to 10

How often the check should run in minutes.

string
required

A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.

string

Path of the script in the runtime.

privateLocations
array of strings

An array of one or more private locations where to run the check.

privateLocations
dependencies
array of objects

An array of BCR dependency files.

dependencies
Headers
string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json