Update a check
curl --request PUT \
--url https://api.checklyhq.com/v1/checks/{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>",
"intent": {
"goal": "<string>",
"requiredOutcomes": [],
"mustPreserve": []
},
"aiAutoRepairEnabled": true,
"frequencyOffset": 2,
"request": {
"url": "<string>",
"followRedirects": true,
"skipSSL": true,
"body": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>",
"locked": true
}
],
"queryParameters": [
{
"key": "<string>",
"value": "<string>",
"locked": true
}
],
"assertions": [
{
"property": "<string>",
"target": "<string>",
"regex": "<string>"
}
],
"basicAuth": {
"username": "<string>",
"password": "<string>"
}
},
"heartbeat": {},
"script": "<string>",
"scriptPath": "<string>",
"sslCheckDomain": "<string>",
"environmentVariables": [
{
"key": "<string>",
"value": "<string>",
"locked": true,
"secret": true
}
],
"setupSnippetId": 123,
"tearDownSnippetId": 123,
"localSetupScript": "<string>",
"localTearDownScript": "<string>",
"degradedResponseTime": 123,
"maxResponseTime": 123,
"privateLocations": [
"<string>"
],
"dependencies": [
{
"path": "<string>",
"content": "<string>"
}
]
}
'import requests
url = "https://api.checklyhq.com/v1/checks/{id}"
payload = {
"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>",
"intent": {
"goal": "<string>",
"requiredOutcomes": [],
"mustPreserve": []
},
"aiAutoRepairEnabled": True,
"frequencyOffset": 2,
"request": {
"url": "<string>",
"followRedirects": True,
"skipSSL": True,
"body": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>",
"locked": True
}
],
"queryParameters": [
{
"key": "<string>",
"value": "<string>",
"locked": True
}
],
"assertions": [
{
"property": "<string>",
"target": "<string>",
"regex": "<string>"
}
],
"basicAuth": {
"username": "<string>",
"password": "<string>"
}
},
"heartbeat": {},
"script": "<string>",
"scriptPath": "<string>",
"sslCheckDomain": "<string>",
"environmentVariables": [
{
"key": "<string>",
"value": "<string>",
"locked": True,
"secret": True
}
],
"setupSnippetId": 123,
"tearDownSnippetId": 123,
"localSetupScript": "<string>",
"localTearDownScript": "<string>",
"degradedResponseTime": 123,
"maxResponseTime": 123,
"privateLocations": ["<string>"],
"dependencies": [
{
"path": "<string>",
"content": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>',
intent: {goal: '<string>', requiredOutcomes: [], mustPreserve: []},
aiAutoRepairEnabled: true,
frequencyOffset: 2,
request: {
url: '<string>',
followRedirects: true,
skipSSL: true,
body: JSON.stringify('<string>'),
headers: [{key: '<string>', value: '<string>', locked: true}],
queryParameters: [{key: '<string>', value: '<string>', locked: true}],
assertions: [{property: '<string>', target: '<string>', regex: '<string>'}],
basicAuth: {username: '<string>', password: '<string>'}
},
heartbeat: {},
script: '<string>',
scriptPath: '<string>',
sslCheckDomain: '<string>',
environmentVariables: [{key: '<string>', value: '<string>', locked: true, secret: true}],
setupSnippetId: 123,
tearDownSnippetId: 123,
localSetupScript: '<string>',
localTearDownScript: '<string>',
degradedResponseTime: 123,
maxResponseTime: 123,
privateLocations: ['<string>'],
dependencies: [{path: '<string>', content: '<string>'}]
})
};
fetch('https://api.checklyhq.com/v1/checks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.checklyhq.com/v1/checks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'intent' => [
'goal' => '<string>',
'requiredOutcomes' => [
],
'mustPreserve' => [
]
],
'aiAutoRepairEnabled' => true,
'frequencyOffset' => 2,
'request' => [
'url' => '<string>',
'followRedirects' => true,
'skipSSL' => true,
'body' => '<string>',
'headers' => [
[
'key' => '<string>',
'value' => '<string>',
'locked' => true
]
],
'queryParameters' => [
[
'key' => '<string>',
'value' => '<string>',
'locked' => true
]
],
'assertions' => [
[
'property' => '<string>',
'target' => '<string>',
'regex' => '<string>'
]
],
'basicAuth' => [
'username' => '<string>',
'password' => '<string>'
]
],
'heartbeat' => [
],
'script' => '<string>',
'scriptPath' => '<string>',
'sslCheckDomain' => '<string>',
'environmentVariables' => [
[
'key' => '<string>',
'value' => '<string>',
'locked' => true,
'secret' => true
]
],
'setupSnippetId' => 123,
'tearDownSnippetId' => 123,
'localSetupScript' => '<string>',
'localTearDownScript' => '<string>',
'degradedResponseTime' => 123,
'maxResponseTime' => 123,
'privateLocations' => [
'<string>'
],
'dependencies' => [
[
'path' => '<string>',
'content' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.checklyhq.com/v1/checks/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"activated\": true,\n \"muted\": true,\n \"doubleCheck\": true,\n \"shouldFail\": true,\n \"locations\": [],\n \"tags\": [\n \"<string>\"\n ],\n \"alertSettings\": {\n \"reminders\": {},\n \"sslCertificates\": {\n \"enabled\": true,\n \"alertThreshold\": 123\n },\n \"runBasedEscalation\": {},\n \"timeBasedEscalation\": {},\n \"parallelRunFailureThreshold\": {\n \"enabled\": true\n }\n },\n \"useGlobalAlertSettings\": true,\n \"groupId\": 123,\n \"groupOrder\": 1,\n \"alertChannelSubscriptions\": [\n {\n \"alertChannelId\": 123,\n \"activated\": true\n }\n ],\n \"retryStrategy\": {\n \"baseBackoffSeconds\": 123,\n \"sameRegion\": true,\n \"maxRetries\": 5.5,\n \"maxDurationSeconds\": 300,\n \"onlyOn\": [\n \"NETWORK_ERROR\"\n ]\n },\n \"triggerIncident\": {\n \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"notifySubscribers\": true\n },\n \"runParallel\": true,\n \"description\": \"<string>\",\n \"intent\": {\n \"goal\": \"<string>\",\n \"requiredOutcomes\": [],\n \"mustPreserve\": []\n },\n \"aiAutoRepairEnabled\": true,\n \"frequencyOffset\": 2,\n \"request\": {\n \"url\": \"<string>\",\n \"followRedirects\": true,\n \"skipSSL\": true,\n \"body\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"queryParameters\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"assertions\": [\n {\n \"property\": \"<string>\",\n \"target\": \"<string>\",\n \"regex\": \"<string>\"\n }\n ],\n \"basicAuth\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"heartbeat\": {},\n \"script\": \"<string>\",\n \"scriptPath\": \"<string>\",\n \"sslCheckDomain\": \"<string>\",\n \"environmentVariables\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true,\n \"secret\": true\n }\n ],\n \"setupSnippetId\": 123,\n \"tearDownSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\",\n \"degradedResponseTime\": 123,\n \"maxResponseTime\": 123,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"dependencies\": [\n {\n \"path\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.checklyhq.com/v1/checks/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"activated\": true,\n \"muted\": true,\n \"doubleCheck\": true,\n \"shouldFail\": true,\n \"locations\": [],\n \"tags\": [\n \"<string>\"\n ],\n \"alertSettings\": {\n \"reminders\": {},\n \"sslCertificates\": {\n \"enabled\": true,\n \"alertThreshold\": 123\n },\n \"runBasedEscalation\": {},\n \"timeBasedEscalation\": {},\n \"parallelRunFailureThreshold\": {\n \"enabled\": true\n }\n },\n \"useGlobalAlertSettings\": true,\n \"groupId\": 123,\n \"groupOrder\": 1,\n \"alertChannelSubscriptions\": [\n {\n \"alertChannelId\": 123,\n \"activated\": true\n }\n ],\n \"retryStrategy\": {\n \"baseBackoffSeconds\": 123,\n \"sameRegion\": true,\n \"maxRetries\": 5.5,\n \"maxDurationSeconds\": 300,\n \"onlyOn\": [\n \"NETWORK_ERROR\"\n ]\n },\n \"triggerIncident\": {\n \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"notifySubscribers\": true\n },\n \"runParallel\": true,\n \"description\": \"<string>\",\n \"intent\": {\n \"goal\": \"<string>\",\n \"requiredOutcomes\": [],\n \"mustPreserve\": []\n },\n \"aiAutoRepairEnabled\": true,\n \"frequencyOffset\": 2,\n \"request\": {\n \"url\": \"<string>\",\n \"followRedirects\": true,\n \"skipSSL\": true,\n \"body\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"queryParameters\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"assertions\": [\n {\n \"property\": \"<string>\",\n \"target\": \"<string>\",\n \"regex\": \"<string>\"\n }\n ],\n \"basicAuth\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"heartbeat\": {},\n \"script\": \"<string>\",\n \"scriptPath\": \"<string>\",\n \"sslCheckDomain\": \"<string>\",\n \"environmentVariables\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true,\n \"secret\": true\n }\n ],\n \"setupSnippetId\": 123,\n \"tearDownSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\",\n \"degradedResponseTime\": 123,\n \"maxResponseTime\": 123,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"dependencies\": [\n {\n \"path\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checklyhq.com/v1/checks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"activated\": true,\n \"muted\": true,\n \"doubleCheck\": true,\n \"shouldFail\": true,\n \"locations\": [],\n \"tags\": [\n \"<string>\"\n ],\n \"alertSettings\": {\n \"reminders\": {},\n \"sslCertificates\": {\n \"enabled\": true,\n \"alertThreshold\": 123\n },\n \"runBasedEscalation\": {},\n \"timeBasedEscalation\": {},\n \"parallelRunFailureThreshold\": {\n \"enabled\": true\n }\n },\n \"useGlobalAlertSettings\": true,\n \"groupId\": 123,\n \"groupOrder\": 1,\n \"alertChannelSubscriptions\": [\n {\n \"alertChannelId\": 123,\n \"activated\": true\n }\n ],\n \"retryStrategy\": {\n \"baseBackoffSeconds\": 123,\n \"sameRegion\": true,\n \"maxRetries\": 5.5,\n \"maxDurationSeconds\": 300,\n \"onlyOn\": [\n \"NETWORK_ERROR\"\n ]\n },\n \"triggerIncident\": {\n \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"notifySubscribers\": true\n },\n \"runParallel\": true,\n \"description\": \"<string>\",\n \"intent\": {\n \"goal\": \"<string>\",\n \"requiredOutcomes\": [],\n \"mustPreserve\": []\n },\n \"aiAutoRepairEnabled\": true,\n \"frequencyOffset\": 2,\n \"request\": {\n \"url\": \"<string>\",\n \"followRedirects\": true,\n \"skipSSL\": true,\n \"body\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"queryParameters\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"assertions\": [\n {\n \"property\": \"<string>\",\n \"target\": \"<string>\",\n \"regex\": \"<string>\"\n }\n ],\n \"basicAuth\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"heartbeat\": {},\n \"script\": \"<string>\",\n \"scriptPath\": \"<string>\",\n \"sslCheckDomain\": \"<string>\",\n \"environmentVariables\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true,\n \"secret\": true\n }\n ],\n \"setupSnippetId\": 123,\n \"tearDownSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\",\n \"degradedResponseTime\": 123,\n \"maxResponseTime\": 123,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"dependencies\": [\n {\n \"path\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"activated": true,
"muted": 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,
"alertChannelSubscriptions": [
{
"alertChannelId": 123,
"activated": true
}
],
"triggerIncident": {
"serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"notifySubscribers": true
},
"runParallel": false,
"description": null,
"intent": null,
"aiAutoRepairEnabled": 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,
"projectBindings": {
"owner": {
"project": {
"id": "<string>",
"logicalId": "<string>",
"name": "<string>"
},
"binding": {
"logicalId": "homepage-check",
"pending": true
}
},
"references": [
{
"project": {
"id": "<string>",
"logicalId": "<string>",
"name": "<string>"
},
"binding": {
"logicalId": "homepage-check",
"pending": true
}
}
]
},
"privateLocations": [
"<string>"
],
"checkType": "HEARTBEAT",
"heartbeat": {
"period": 123,
"grace": 123,
"pingToken": "<string>",
"pingUrl": "<string>"
}
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}Checks and Monitors
Update a check
deprecated
[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}
Update a check
curl --request PUT \
--url https://api.checklyhq.com/v1/checks/{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>",
"intent": {
"goal": "<string>",
"requiredOutcomes": [],
"mustPreserve": []
},
"aiAutoRepairEnabled": true,
"frequencyOffset": 2,
"request": {
"url": "<string>",
"followRedirects": true,
"skipSSL": true,
"body": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>",
"locked": true
}
],
"queryParameters": [
{
"key": "<string>",
"value": "<string>",
"locked": true
}
],
"assertions": [
{
"property": "<string>",
"target": "<string>",
"regex": "<string>"
}
],
"basicAuth": {
"username": "<string>",
"password": "<string>"
}
},
"heartbeat": {},
"script": "<string>",
"scriptPath": "<string>",
"sslCheckDomain": "<string>",
"environmentVariables": [
{
"key": "<string>",
"value": "<string>",
"locked": true,
"secret": true
}
],
"setupSnippetId": 123,
"tearDownSnippetId": 123,
"localSetupScript": "<string>",
"localTearDownScript": "<string>",
"degradedResponseTime": 123,
"maxResponseTime": 123,
"privateLocations": [
"<string>"
],
"dependencies": [
{
"path": "<string>",
"content": "<string>"
}
]
}
'import requests
url = "https://api.checklyhq.com/v1/checks/{id}"
payload = {
"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>",
"intent": {
"goal": "<string>",
"requiredOutcomes": [],
"mustPreserve": []
},
"aiAutoRepairEnabled": True,
"frequencyOffset": 2,
"request": {
"url": "<string>",
"followRedirects": True,
"skipSSL": True,
"body": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>",
"locked": True
}
],
"queryParameters": [
{
"key": "<string>",
"value": "<string>",
"locked": True
}
],
"assertions": [
{
"property": "<string>",
"target": "<string>",
"regex": "<string>"
}
],
"basicAuth": {
"username": "<string>",
"password": "<string>"
}
},
"heartbeat": {},
"script": "<string>",
"scriptPath": "<string>",
"sslCheckDomain": "<string>",
"environmentVariables": [
{
"key": "<string>",
"value": "<string>",
"locked": True,
"secret": True
}
],
"setupSnippetId": 123,
"tearDownSnippetId": 123,
"localSetupScript": "<string>",
"localTearDownScript": "<string>",
"degradedResponseTime": 123,
"maxResponseTime": 123,
"privateLocations": ["<string>"],
"dependencies": [
{
"path": "<string>",
"content": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>',
intent: {goal: '<string>', requiredOutcomes: [], mustPreserve: []},
aiAutoRepairEnabled: true,
frequencyOffset: 2,
request: {
url: '<string>',
followRedirects: true,
skipSSL: true,
body: JSON.stringify('<string>'),
headers: [{key: '<string>', value: '<string>', locked: true}],
queryParameters: [{key: '<string>', value: '<string>', locked: true}],
assertions: [{property: '<string>', target: '<string>', regex: '<string>'}],
basicAuth: {username: '<string>', password: '<string>'}
},
heartbeat: {},
script: '<string>',
scriptPath: '<string>',
sslCheckDomain: '<string>',
environmentVariables: [{key: '<string>', value: '<string>', locked: true, secret: true}],
setupSnippetId: 123,
tearDownSnippetId: 123,
localSetupScript: '<string>',
localTearDownScript: '<string>',
degradedResponseTime: 123,
maxResponseTime: 123,
privateLocations: ['<string>'],
dependencies: [{path: '<string>', content: '<string>'}]
})
};
fetch('https://api.checklyhq.com/v1/checks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.checklyhq.com/v1/checks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'intent' => [
'goal' => '<string>',
'requiredOutcomes' => [
],
'mustPreserve' => [
]
],
'aiAutoRepairEnabled' => true,
'frequencyOffset' => 2,
'request' => [
'url' => '<string>',
'followRedirects' => true,
'skipSSL' => true,
'body' => '<string>',
'headers' => [
[
'key' => '<string>',
'value' => '<string>',
'locked' => true
]
],
'queryParameters' => [
[
'key' => '<string>',
'value' => '<string>',
'locked' => true
]
],
'assertions' => [
[
'property' => '<string>',
'target' => '<string>',
'regex' => '<string>'
]
],
'basicAuth' => [
'username' => '<string>',
'password' => '<string>'
]
],
'heartbeat' => [
],
'script' => '<string>',
'scriptPath' => '<string>',
'sslCheckDomain' => '<string>',
'environmentVariables' => [
[
'key' => '<string>',
'value' => '<string>',
'locked' => true,
'secret' => true
]
],
'setupSnippetId' => 123,
'tearDownSnippetId' => 123,
'localSetupScript' => '<string>',
'localTearDownScript' => '<string>',
'degradedResponseTime' => 123,
'maxResponseTime' => 123,
'privateLocations' => [
'<string>'
],
'dependencies' => [
[
'path' => '<string>',
'content' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.checklyhq.com/v1/checks/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"activated\": true,\n \"muted\": true,\n \"doubleCheck\": true,\n \"shouldFail\": true,\n \"locations\": [],\n \"tags\": [\n \"<string>\"\n ],\n \"alertSettings\": {\n \"reminders\": {},\n \"sslCertificates\": {\n \"enabled\": true,\n \"alertThreshold\": 123\n },\n \"runBasedEscalation\": {},\n \"timeBasedEscalation\": {},\n \"parallelRunFailureThreshold\": {\n \"enabled\": true\n }\n },\n \"useGlobalAlertSettings\": true,\n \"groupId\": 123,\n \"groupOrder\": 1,\n \"alertChannelSubscriptions\": [\n {\n \"alertChannelId\": 123,\n \"activated\": true\n }\n ],\n \"retryStrategy\": {\n \"baseBackoffSeconds\": 123,\n \"sameRegion\": true,\n \"maxRetries\": 5.5,\n \"maxDurationSeconds\": 300,\n \"onlyOn\": [\n \"NETWORK_ERROR\"\n ]\n },\n \"triggerIncident\": {\n \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"notifySubscribers\": true\n },\n \"runParallel\": true,\n \"description\": \"<string>\",\n \"intent\": {\n \"goal\": \"<string>\",\n \"requiredOutcomes\": [],\n \"mustPreserve\": []\n },\n \"aiAutoRepairEnabled\": true,\n \"frequencyOffset\": 2,\n \"request\": {\n \"url\": \"<string>\",\n \"followRedirects\": true,\n \"skipSSL\": true,\n \"body\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"queryParameters\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"assertions\": [\n {\n \"property\": \"<string>\",\n \"target\": \"<string>\",\n \"regex\": \"<string>\"\n }\n ],\n \"basicAuth\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"heartbeat\": {},\n \"script\": \"<string>\",\n \"scriptPath\": \"<string>\",\n \"sslCheckDomain\": \"<string>\",\n \"environmentVariables\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true,\n \"secret\": true\n }\n ],\n \"setupSnippetId\": 123,\n \"tearDownSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\",\n \"degradedResponseTime\": 123,\n \"maxResponseTime\": 123,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"dependencies\": [\n {\n \"path\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.checklyhq.com/v1/checks/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"activated\": true,\n \"muted\": true,\n \"doubleCheck\": true,\n \"shouldFail\": true,\n \"locations\": [],\n \"tags\": [\n \"<string>\"\n ],\n \"alertSettings\": {\n \"reminders\": {},\n \"sslCertificates\": {\n \"enabled\": true,\n \"alertThreshold\": 123\n },\n \"runBasedEscalation\": {},\n \"timeBasedEscalation\": {},\n \"parallelRunFailureThreshold\": {\n \"enabled\": true\n }\n },\n \"useGlobalAlertSettings\": true,\n \"groupId\": 123,\n \"groupOrder\": 1,\n \"alertChannelSubscriptions\": [\n {\n \"alertChannelId\": 123,\n \"activated\": true\n }\n ],\n \"retryStrategy\": {\n \"baseBackoffSeconds\": 123,\n \"sameRegion\": true,\n \"maxRetries\": 5.5,\n \"maxDurationSeconds\": 300,\n \"onlyOn\": [\n \"NETWORK_ERROR\"\n ]\n },\n \"triggerIncident\": {\n \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"notifySubscribers\": true\n },\n \"runParallel\": true,\n \"description\": \"<string>\",\n \"intent\": {\n \"goal\": \"<string>\",\n \"requiredOutcomes\": [],\n \"mustPreserve\": []\n },\n \"aiAutoRepairEnabled\": true,\n \"frequencyOffset\": 2,\n \"request\": {\n \"url\": \"<string>\",\n \"followRedirects\": true,\n \"skipSSL\": true,\n \"body\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"queryParameters\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"assertions\": [\n {\n \"property\": \"<string>\",\n \"target\": \"<string>\",\n \"regex\": \"<string>\"\n }\n ],\n \"basicAuth\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"heartbeat\": {},\n \"script\": \"<string>\",\n \"scriptPath\": \"<string>\",\n \"sslCheckDomain\": \"<string>\",\n \"environmentVariables\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true,\n \"secret\": true\n }\n ],\n \"setupSnippetId\": 123,\n \"tearDownSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\",\n \"degradedResponseTime\": 123,\n \"maxResponseTime\": 123,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"dependencies\": [\n {\n \"path\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checklyhq.com/v1/checks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"activated\": true,\n \"muted\": true,\n \"doubleCheck\": true,\n \"shouldFail\": true,\n \"locations\": [],\n \"tags\": [\n \"<string>\"\n ],\n \"alertSettings\": {\n \"reminders\": {},\n \"sslCertificates\": {\n \"enabled\": true,\n \"alertThreshold\": 123\n },\n \"runBasedEscalation\": {},\n \"timeBasedEscalation\": {},\n \"parallelRunFailureThreshold\": {\n \"enabled\": true\n }\n },\n \"useGlobalAlertSettings\": true,\n \"groupId\": 123,\n \"groupOrder\": 1,\n \"alertChannelSubscriptions\": [\n {\n \"alertChannelId\": 123,\n \"activated\": true\n }\n ],\n \"retryStrategy\": {\n \"baseBackoffSeconds\": 123,\n \"sameRegion\": true,\n \"maxRetries\": 5.5,\n \"maxDurationSeconds\": 300,\n \"onlyOn\": [\n \"NETWORK_ERROR\"\n ]\n },\n \"triggerIncident\": {\n \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"notifySubscribers\": true\n },\n \"runParallel\": true,\n \"description\": \"<string>\",\n \"intent\": {\n \"goal\": \"<string>\",\n \"requiredOutcomes\": [],\n \"mustPreserve\": []\n },\n \"aiAutoRepairEnabled\": true,\n \"frequencyOffset\": 2,\n \"request\": {\n \"url\": \"<string>\",\n \"followRedirects\": true,\n \"skipSSL\": true,\n \"body\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"queryParameters\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true\n }\n ],\n \"assertions\": [\n {\n \"property\": \"<string>\",\n \"target\": \"<string>\",\n \"regex\": \"<string>\"\n }\n ],\n \"basicAuth\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"heartbeat\": {},\n \"script\": \"<string>\",\n \"scriptPath\": \"<string>\",\n \"sslCheckDomain\": \"<string>\",\n \"environmentVariables\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"locked\": true,\n \"secret\": true\n }\n ],\n \"setupSnippetId\": 123,\n \"tearDownSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\",\n \"degradedResponseTime\": 123,\n \"maxResponseTime\": 123,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"dependencies\": [\n {\n \"path\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"activated": true,
"muted": 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,
"alertChannelSubscriptions": [
{
"alertChannelId": 123,
"activated": true
}
],
"triggerIncident": {
"serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"notifySubscribers": true
},
"runParallel": false,
"description": null,
"intent": null,
"aiAutoRepairEnabled": 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,
"projectBindings": {
"owner": {
"project": {
"id": "<string>",
"logicalId": "<string>",
"name": "<string>"
},
"binding": {
"logicalId": "homepage-check",
"pending": true
}
},
"references": [
{
"project": {
"id": "<string>",
"logicalId": "<string>",
"name": "<string>"
},
"binding": {
"logicalId": "homepage-check",
"pending": true
}
}
]
},
"privateLocations": [
"<string>"
],
"checkType": "HEARTBEAT",
"heartbeat": {
"period": 123,
"grace": 123,
"pingToken": "<string>",
"pingUrl": "<string>"
}
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}Authorizations
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
Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
Path Parameters
Minimum string length:
1Query Parameters
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.
Body
application/json
Minimum string length:
1Available 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 Minimum string length:
1Show child attributes
Show child attributes
Required range:
x >= 0Available options:
2026.04, 2025.04, 2024.09, 2024.02, 2023.09, 2023.02, 2022.10, null Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
510Show child attributes
Show child attributes
Available options:
AGENTIC, API, BROWSER, HEARTBEAT, ICMP, MULTI_STEP, TCP, PLAYWRIGHT, TRACEROUTE, URL, DNS, SSL, GRPC Available options:
0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, 1440 Required range:
x >= 1- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Minimum string length:
1Maximum array length:
200Show child attributes
Show child attributes
Minimum string length:
1Show child attributes
Show child attributes
Response
Successful
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
Minimum string length:
1Available 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 Minimum string length:
1Show child attributes
Show child attributes
Required range:
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
500Show child attributes
Show child attributes
Show child attributes
Show child attributes
The project that manages this check, or null when the check is not managed by code. When a check has more than one binding, this reports the preferred one.
Show child attributes
Show child attributes
The check's logical ID within the managing project, or null when it is not managed by code.
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.
True when the binding is reserved by an import plan that has not been deployed yet. Null when not managed by code.
The Checkly CLI projects that manage this resource. owner is null and references empty when the resource is not managed by code.
Show child attributes
Show child attributes
Minimum string length:
1Available options:
HEARTBEAT Show child attributes
Show child attributes
Was this page helpful?
⌘I