Update a multi-step check

Updates a Multi-Step check.

PUT /v1/checks/multistep/{id}

Update a multi-step check

cURL

curl --request PUT \
  --url https://api.checklyhq.com/v1/checks/multistep/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "activated": true,
  "muted": true,
  "doubleCheck": true,
  "shouldFail": true,
  "locations": [],
  "tags": [
    "<string>"
  ],
  "alertSettings": {
    "reminders": {},
    "sslCertificates": {
      "enabled": true,
      "alertThreshold": 123
    },
    "runBasedEscalation": {},
    "timeBasedEscalation": {},
    "parallelRunFailureThreshold": {
      "enabled": true
    }
  },
  "useGlobalAlertSettings": true,
  "groupId": 123,
  "groupOrder": 1,
  "alertChannelSubscriptions": [
    {
      "alertChannelId": 123,
      "activated": true
    }
  ],
  "retryStrategy": {
    "baseBackoffSeconds": 123,
    "sameRegion": true,
    "maxRetries": 5.5,
    "maxDurationSeconds": 300,
    "onlyOn": [
      "NETWORK_ERROR"
    ]
  },
  "triggerIncident": {
    "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "notifySubscribers": true
  },
  "runParallel": true,
  "description": "<string>",
  "checkType": "MULTI_STEP",
  "environmentVariables": [
    {
      "key": "<string>",
      "value": "<string>",
      "locked": true,
      "secret": true
    }
  ],
  "script": "<string>",
  "scriptPath": "<string>",
  "privateLocations": [
    "<string>"
  ],
  "dependencies": [
    {
      "path": "<string>",
      "content": "<string>"
    }
  ]
}
'

200

{
  "name": "<string>",
  "script": "<string>",
  "activated": true,
  "muted": false,
  "doubleCheck": true,
  "shouldFail": false,
  "locations": [],
  "tags": [],
  "alertSettings": {
    "escalationType": "RUN_BASED",
    "runBasedEscalation": {
      "failedRunThreshold": 1
    },
    "reminders": {
      "amount": 0,
      "interval": 5
    },
    "parallelRunFailureThreshold": {
      "enabled": false,
      "percentage": 10
    }
  },
  "useGlobalAlertSettings": true,
  "groupId": null,
  "groupOrder": null,
  "runtimeId": null,
  "alertChannelSubscriptions": [
    {
      "alertChannelId": 123,
      "activated": true
    }
  ],
  "retryStrategy": {
    "baseBackoffSeconds": 60,
    "sameRegion": true,
    "maxRetries": 5.5,
    "maxDurationSeconds": 300,
    "onlyOn": [
      "NETWORK_ERROR"
    ]
  },
  "triggerIncident": {
    "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "notifySubscribers": true
  },
  "runParallel": false,
  "description": null,
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "alertChannels": {
    "email": [
      {
        "address": ""
      }
    ],
    "webhook": [
      {
        "name": "",
        "url": "",
        "method": "POST",
        "headers": [],
        "queryParameters": []
      }
    ],
    "slack": [
      {
        "url": ""
      }
    ],
    "sms": [
      {
        "name": "<string>",
        "number": ""
      }
    ]
  },
  "project": {
    "id": "<string>",
    "logicalId": "<string>",
    "name": "<string>"
  },
  "logicalId": "<string>",
  "member": true,
  "pending": true,
  "privateLocations": [
    "<string>"
  ],
  "checkType": "MULTI_STEP",
  "frequency": 10,
  "environmentVariables": [
    {
      "key": "<string>",
      "value": "<string>",
      "locked": false,
      "secret": false
    }
  ]
}

Authorizations

Authorization · string · header · required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

x-checkly-account · string<uuid>

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

Path Parameters

id · string<uuid> · required

Minimum string length: 1

Query Parameters

autoAssignAlerts · boolean · default: true

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

Body

application/json

name · string

Minimum string length: 1

activated · boolean

muted · boolean

doubleCheck · boolean

shouldFail · boolean

locations · enum<string>[] | null

Available options: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, sa-east-1, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, me-south-1, ap-southeast-1, ap-northeast-1, ap-east-1, ap-southeast-2, ap-southeast-3, ap-northeast-2, ap-northeast-3, ap-south-1, af-south-1

tags · string[]

Minimum string length: 1

alertSettings · object

Show child attributes

useGlobalAlertSettings · boolean

groupId · number | null

groupOrder · number | null

Required range: x >= 0

runtimeId · enum<string> | null

Available options: 2026.04, 2025.04, 2024.09, 2024.02, 2023.09, 2023.02, 2022.10, null

alertChannelSubscriptions · object[]

Show child attributes

retryStrategy · object | null

Show child attributes

triggerIncident · object | null

Show child attributes

runParallel · boolean

description · string | null

Maximum string length: 500

checkType · enum<string>

Available options: MULTI_STEP

environmentVariables · object[] | null

Maximum array length: 100

Show child attributes

frequency · enum<integer>

Available options: 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, 1440

script · string | null

Minimum string length: 1

scriptPath · string | null

Minimum string length: 1

privateLocations · string[] | null

Minimum string length: 1

dependencies · object[] | null

Show child attributes

Response

200

application/json

Successful

name · string · required

Minimum string length: 1

script · string | null · required

activated · boolean · default: true

muted · boolean · default: false

doubleCheck · boolean · default: true

shouldFail · boolean · default: false

locations · enum<string>[] | null

Available options: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, sa-east-1, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, me-south-1, ap-southeast-1, ap-northeast-1, ap-east-1, ap-southeast-2, ap-southeast-3, ap-northeast-2, ap-northeast-3, ap-south-1, af-south-1

tags · string[]

Minimum string length: 1

alertSettings · object | null

Show child attributes

useGlobalAlertSettings · boolean · default: true

groupId · number | null

groupOrder · number | null

Required range: x >= 0

runtimeId · enum<string> | null

Available options: 2026.04, 2025.04, 2024.09, 2024.02, 2023.09, 2023.02, 2022.10, null

alertChannelSubscriptions · object[]

Show child attributes

retryStrategy · object | null

Show child attributes

triggerIncident · object | null

Show child attributes

runParallel · boolean · default: false

description · string | null

Maximum string length: 500

id · string

created_at · string<date-time>

updated_at · string<date-time> | null

alertChannels · object | null

Show child attributes

project · object | null

The project that manages this check, or null when the check is not managed by code.

Show child attributes

logicalId · string | null

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

member · boolean | null

True when the project owns this check, false when it merely references a check owned outside the project. Null when not managed by code.

pending · boolean | null

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

privateLocations · string[] | null

Minimum string length: 1

checkType · enum<string>

Available options: MULTI_STEP

frequency · enum<integer> · default: 10

Available options: 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, 1440

environmentVariables · object[] | null

Maximum array length: 100

Show child attributes