PUT
/
v1
/
checks
/
{id}
Update a check
curl --request PUT \
  --url https://api.checklyhq.com/v1/checks/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Check",
  "activated": true,
  "muted": false,
  "doubleCheck": true,
  "shouldFail": false,
  "locations": [
    "us-east-1",
    "eu-central-1"
  ],
  "tags": [
    "production"
  ],
  "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": [],
  "retryStrategy": {
    "type": "FIXED",
    "baseBackoffSeconds": 60,
    "maxRetries": 2,
    "maxDurationSeconds": 600,
    "sameRegion": true,
    "onlyOn": [
      "NETWORK_ERROR"
    ]
  },
  "runParallel": false,
  "checkType": "API",
  "frequency": 10,
  "frequencyOffset": 2,
  "request": {},
  "heartbeat": {},
  "script": "<string>",
  "scriptPath": "<string>",
  "sslCheckDomain": "<string>",
  "environmentVariables": [
    {
      "key": "API_KEY",
      "value": "<string>",
      "locked": false,
      "secret": false
    }
  ],
  "setupSnippetId": null,
  "tearDownSnippetId": null,
  "localSetupScript": null,
  "localTearDownScript": null,
  "privateLocations": [
    "data-center-eu"
  ],
  "dependencies": [
    {
      "path": "<string>",
      "content": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "checkType": "API"
}

​
Overview

The Update Check endpoint allows you to modify existing check configurations, including scripts, settings, schedules, and monitoring locations. Common Use Cases:
  • Check Configuration Updates
  • Script Modifications
  • Schedule Changes
  • Location Updates
Updating checks may temporarily affect monitoring. Consider the impact on alerting and reporting when making changes to active checks.
Changes to check configurations take effect immediately. Ensure proper testing before updating production monitoring checks.

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

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

Path Parameters

​
id
string
required

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
​
heartbeat
object
required
​
script
string
required
​
name
string

The name of the check.

Example:

"Check"

​
activated
boolean
default:true

Determines if the check is running or not.

​
muted
boolean
default:false

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

​
doubleCheck
boolean
default:true

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

​
shouldFail
boolean
default:false

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

​
locations
enum<string>[]

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

Example:
["us-east-1", "eu-central-1"]
​
tags
string[]

Tags for organizing and filtering checks.

Example:
["production"]
​
alertSettings
object

Alert settings.

​
useGlobalAlertSettings
boolean
default:true

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

​
groupId
number

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

Example:

null

​
groupOrder
number

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.

Required range: x >= 0
Example:

null

​
runtimeId
enum<string>

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

Available options:
2025.04,
2024.09,
2024.02,
2023.09,
2023.02,
2022.10
​
alertChannelSubscriptions
object[]

List of alert channel subscriptions.

Example:
[]
​
retryStrategy
object

The strategy to determine how failed checks are retried.

​
runParallel
boolean
default:false

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

​
checkType
enum<string>

The type of the check.

Available options:
API,
BROWSER,
HEARTBEAT,
MULTI_STEP,
TCP,
PLAYWRIGHT,
URL
​
frequency
integer
default:10

How often the check should run in minutes.

​
frequencyOffset
integer

Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula "Math.floor(frequency * 10)", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula "Math.ceil(frequency / 60)", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12.

Required range: x >= 1
​
request
object
​
scriptPath
string

Path of the script in the runtime.

​
sslCheckDomain
string
​
environmentVariables
object[]

Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.

Maximum length: 50
​
setupSnippetId
number

An ID reference to a snippet to use in the setup phase of an API check.

​
tearDownSnippetId
number

An ID reference to a snippet to use in the teardown phase of an API check.

​
localSetupScript
string

A valid piece of Node.js code to run in the setup phase.

​
localTearDownScript
string

A valid piece of Node.js code to run in the teardown phase.

​
privateLocations
string[]

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

Example:
["data-center-eu"]
​
dependencies
object[]

An array of BCR dependency files.

Response

Successful

​
checkType
enum<string>
required

The type of the check.

Available options:
API,
BROWSER,
HEARTBEAT,
MULTI_STEP,
TCP,
PLAYWRIGHT,
URL
​
id
string