Skip to Content
API ReferenceUpdate Check

Update Check

Update an existing monitoring check. Only the fields you include in the request body will be changed.

Required scope: checks:write

Endpoint

PATCH /v1/public/checks/{id}

Path Parameters

ParameterTypeDescription
idstringThe unique check identifier

Request Body

All fields are optional. Only include the fields you want to change.

FieldTypeDescription
urlstringThe URL to monitor
namestringDisplay name (max 200 characters)
typestringCheck type: website, rest_endpoint, ping, tcp, udp, dns, smtp, pop3, imap
checkFrequencynumberCheck interval in minutes (subject to plan limits)
checkRegionOverridestringRegion to run checks from. Currently only vps-eu-1 is available
httpMethodstringHTTP method: GET, POST, PUT, PATCH, DELETE, HEAD
expectedStatusCodesnumber[]Expected HTTP status codes
requestHeadersobjectCustom request headers as key-value pairs (max 20 entries)
requestBodystringRequest body for POST/PUT/PATCH methods (max 64KB)
responseValidationobjectResponse validation rules
cacheControlNoCachebooleanSend Cache-Control: no-cache header
immediateRecheckEnabledbooleanEnable immediate recheck on failure
responseTimeLimitnumberMax response time in milliseconds
downConfirmationAttemptsnumberConsecutive failures before marking as down (1-99)
pingPacketsnumberNumber of ping packets for ping type checks (1-5)
timezonestringTimezone for the check

Note: When you update fields that affect check behavior (URL, type, frequency, headers, etc.), the check schedule is reset and the next check runs immediately.

Response

200 OK

{ "data": { "success": true } }

Error Responses

StatusDescription
400Invalid field value or validation failure
403API key missing checks:write scope, or check belongs to another user
404Check not found
409A check already exists for this URL

Code Examples

cURL

curl -X PATCH \ -H "X-Api-Key: ek_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{"name": "Updated Name", "checkFrequency": 10}' \ "https://us-central1-exit1-dev.cloudfunctions.net/publicApi/v1/public/checks/CHECK_ID"

JavaScript

const checkId = "CHECK_ID"; const response = await fetch( `https://us-central1-exit1-dev.cloudfunctions.net/publicApi/v1/public/checks/${checkId}`, { method: "PATCH", headers: { "X-Api-Key": process.env.EXIT1_API_KEY, "Content-Type": "application/json", }, body: JSON.stringify({ name: "Updated Name", checkFrequency: 10, }), } ); const data = await response.json(); console.log(data);

Python

import os, requests check_id = "CHECK_ID" response = requests.patch( f"https://us-central1-exit1-dev.cloudfunctions.net/publicApi/v1/public/checks/{check_id}", headers={"X-Api-Key": os.environ["EXIT1_API_KEY"]}, json={"name": "Updated Name", "checkFrequency": 10}, ) response.raise_for_status() print(response.json())
Last updated on