Update an API check
curl --request PUT \
--url https://api.checklyhq.com/v1/checks/api/{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": "API",
"frequencyOffset": 2,
"degradedResponseTime": 22500,
"maxResponseTime": 22500,
"privateLocations": [
"<string>"
],
"tearDownSnippetId": 123,
"setupSnippetId": 123,
"localSetupScript": "<string>",
"localTearDownScript": "<string>"
}
'import requests
url = "https://api.checklyhq.com/v1/checks/api/{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>",
"checkType": "API",
"frequencyOffset": 2,
"degradedResponseTime": 22500,
"maxResponseTime": 22500,
"privateLocations": ["<string>"],
"tearDownSnippetId": 123,
"setupSnippetId": 123,
"localSetupScript": "<string>",
"localTearDownScript": "<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>',
checkType: 'API',
frequencyOffset: 2,
degradedResponseTime: 22500,
maxResponseTime: 22500,
privateLocations: ['<string>'],
tearDownSnippetId: 123,
setupSnippetId: 123,
localSetupScript: '<string>',
localTearDownScript: '<string>'
})
};
fetch('https://api.checklyhq.com/v1/checks/api/{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/api/{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>',
'checkType' => 'API',
'frequencyOffset' => 2,
'degradedResponseTime' => 22500,
'maxResponseTime' => 22500,
'privateLocations' => [
'<string>'
],
'tearDownSnippetId' => 123,
'setupSnippetId' => 123,
'localSetupScript' => '<string>',
'localTearDownScript' => '<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/api/{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 \"checkType\": \"API\",\n \"frequencyOffset\": 2,\n \"degradedResponseTime\": 22500,\n \"maxResponseTime\": 22500,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"tearDownSnippetId\": 123,\n \"setupSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\"\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/api/{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 \"checkType\": \"API\",\n \"frequencyOffset\": 2,\n \"degradedResponseTime\": 22500,\n \"maxResponseTime\": 22500,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"tearDownSnippetId\": 123,\n \"setupSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checklyhq.com/v1/checks/api/{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 \"checkType\": \"API\",\n \"frequencyOffset\": 2,\n \"degradedResponseTime\": 22500,\n \"maxResponseTime\": 22500,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"tearDownSnippetId\": 123,\n \"setupSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<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": ""
}
]
},
"privateLocations": [
"<string>"
],
"frequency": 10,
"frequencyOffset": 2,
"degradedResponseTime": 123,
"maxResponseTime": 123,
"checkType": "API",
"request": {
"url": "<string>",
"followRedirects": true,
"skipSSL": false,
"ipFamily": "IPv4",
"body": "",
"bodyType": "NONE",
"headers": [],
"queryParameters": [],
"assertions": [],
"basicAuth": {
"username": "<string>",
"password": "<string>"
}
},
"tearDownSnippetId": null,
"setupSnippetId": null,
"localSetupScript": null,
"localTearDownScript": null
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}API Check
Update an API check
Updates an API check.
PUT
/
v1
/
checks
/
api
/
{id}
Update an API check
curl --request PUT \
--url https://api.checklyhq.com/v1/checks/api/{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": "API",
"frequencyOffset": 2,
"degradedResponseTime": 22500,
"maxResponseTime": 22500,
"privateLocations": [
"<string>"
],
"tearDownSnippetId": 123,
"setupSnippetId": 123,
"localSetupScript": "<string>",
"localTearDownScript": "<string>"
}
'import requests
url = "https://api.checklyhq.com/v1/checks/api/{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>",
"checkType": "API",
"frequencyOffset": 2,
"degradedResponseTime": 22500,
"maxResponseTime": 22500,
"privateLocations": ["<string>"],
"tearDownSnippetId": 123,
"setupSnippetId": 123,
"localSetupScript": "<string>",
"localTearDownScript": "<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>',
checkType: 'API',
frequencyOffset: 2,
degradedResponseTime: 22500,
maxResponseTime: 22500,
privateLocations: ['<string>'],
tearDownSnippetId: 123,
setupSnippetId: 123,
localSetupScript: '<string>',
localTearDownScript: '<string>'
})
};
fetch('https://api.checklyhq.com/v1/checks/api/{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/api/{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>',
'checkType' => 'API',
'frequencyOffset' => 2,
'degradedResponseTime' => 22500,
'maxResponseTime' => 22500,
'privateLocations' => [
'<string>'
],
'tearDownSnippetId' => 123,
'setupSnippetId' => 123,
'localSetupScript' => '<string>',
'localTearDownScript' => '<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/api/{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 \"checkType\": \"API\",\n \"frequencyOffset\": 2,\n \"degradedResponseTime\": 22500,\n \"maxResponseTime\": 22500,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"tearDownSnippetId\": 123,\n \"setupSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\"\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/api/{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 \"checkType\": \"API\",\n \"frequencyOffset\": 2,\n \"degradedResponseTime\": 22500,\n \"maxResponseTime\": 22500,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"tearDownSnippetId\": 123,\n \"setupSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checklyhq.com/v1/checks/api/{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 \"checkType\": \"API\",\n \"frequencyOffset\": 2,\n \"degradedResponseTime\": 22500,\n \"maxResponseTime\": 22500,\n \"privateLocations\": [\n \"<string>\"\n ],\n \"tearDownSnippetId\": 123,\n \"setupSnippetId\": 123,\n \"localSetupScript\": \"<string>\",\n \"localTearDownScript\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<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": ""
}
]
},
"privateLocations": [
"<string>"
],
"frequency": 10,
"frequencyOffset": 2,
"degradedResponseTime": 123,
"maxResponseTime": 123,
"checkType": "API",
"request": {
"url": "<string>",
"followRedirects": true,
"skipSSL": false,
"ipFamily": "IPv4",
"body": "",
"bodyType": "NONE",
"headers": [],
"queryParameters": [],
"assertions": [],
"basicAuth": {
"username": "<string>",
"password": "<string>"
}
},
"tearDownSnippetId": null,
"setupSnippetId": null,
"localSetupScript": null,
"localTearDownScript": null
}{
"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:
500Available options:
API Show child attributes
Show child attributes
Available options:
0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, 1440 Required range:
x >= 1Required range:
0 <= x <= 45000Required range:
0 <= x <= 45000Minimum string length:
1Response
Successful
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:
500Show child attributes
Show child attributes
Minimum string length:
1Available options:
0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, 1440 Required range:
x >= 1Available options:
API Show child attributes
Show child attributes
Was this page helpful?
⌘I