latestOpenAPI 3.0.02026-08-121915501.4 MB

87d29dc7b4fe

Checks

Update a check

[DEPRECATED] This endpoint will be removed soon. Instead use PUT /checks/api/{id} or PUT /checks/browser/{id}. Updates a new API or browser check.

put/v1/checks/{id}

Path parameters

idstring uuid required

Query parameters

autoAssignAlertsboolean

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

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

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

Request body

namestring
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'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'TRACEROUTE' | 'URL' | 'DNS' | 'SSL' | 'GRPC'
frequency0 | 1 | 2 | 5 | 10 | 15 | 30 | 60 | 120 | 180 | 360 | 720 | 1440
frequencyOffsetinteger
heartbeatobject nullable
scriptstring nullable
scriptPathstring nullable
sslCheckDomainstring nullable
setupSnippetIdnumber nullable
tearDownSnippetIdnumber nullable
localSetupScriptstring nullable
localTearDownScriptstring nullable
degradedResponseTimenumber nullable
maxResponseTimenumber nullable
privateLocationsstring[] nullable

Response

Successful

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

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