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
| Parameter | Type | Description |
|---|---|---|
id | string | The unique check identifier |
Request Body
All fields are optional. Only include the fields you want to change.
| Field | Type | Description |
|---|---|---|
url | string | The URL to monitor |
name | string | Display name (max 200 characters) |
type | string | Check type: website, rest_endpoint, ping, tcp, udp, dns, smtp, pop3, imap |
checkFrequency | number | Check interval in minutes (subject to plan limits) |
checkRegionOverride | string | Region to run checks from. Currently only vps-eu-1 is available |
httpMethod | string | HTTP method: GET, POST, PUT, PATCH, DELETE, HEAD |
expectedStatusCodes | number[] | Expected HTTP status codes |
requestHeaders | object | Custom request headers as key-value pairs (max 20 entries) |
requestBody | string | Request body for POST/PUT/PATCH methods (max 64KB) |
responseValidation | object | Response validation rules |
cacheControlNoCache | boolean | Send Cache-Control: no-cache header |
immediateRecheckEnabled | boolean | Enable immediate recheck on failure |
responseTimeLimit | number | Max response time in milliseconds |
downConfirmationAttempts | number | Consecutive failures before marking as down (1-99) |
pingPackets | number | Number of ping packets for ping type checks (1-5) |
timezone | string | Timezone 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
| Status | Description |
|---|---|
| 400 | Invalid field value or validation failure |
| 403 | API key missing checks:write scope, or check belongs to another user |
| 404 | Check not found |
| 409 | A 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