Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Temporarily stop checking a monitor
POST https://api.uptimeio.com/api/monitors/{id}/pause
| Header | Required | Description |
|---|---|---|
X-API-Key | Yes (or a Bearer token) | Your API key with read and write access. Read-only keys receive READ_ONLY_API_KEY (403). See Authentication. |
X-Project-ID | No | Project that contains the monitor. Defaults to your organization’s default project. |
| Parameter | Type | Required | Description |
|---|---|---|---|
id | UUID | Yes | Monitor ID. |
status and configState are paused.
{
"success": true,
"data": {
"monitor": {
"id": "b7a2c1de-3f54-4c21-9d0a-6e1f2a3b4c5d",
"name": "Production API",
"type": "HTTP",
"target": "https://api.example.com/health",
"interval_seconds": 60,
"status": "paused",
"configState": "paused",
"runtimeStatus": "paused"
}
}
}
| Code | Status | Meaning |
|---|---|---|
AUTHENTICATION_REQUIRED / MISSING_AUTH / INVALID_API_KEY | 401 | Missing or invalid credentials. |
READ_ONLY_API_KEY | 403 | The key has read-only access. |
MONITOR_NOT_FOUND | 404 | No monitor with this ID in the project. |
MONITOR_PAUSE_FAILED | 500 | The monitor could not be paused. |
curl -X POST https://api.uptimeio.com/api/monitors/MONITOR_ID/pause \
-H "X-API-Key: YOUR_API_KEY"
const res = await fetch('https://api.uptimeio.com/api/monitors/MONITOR_ID/pause', {
method: 'POST',
headers: { 'X-API-Key': process.env.UPTIMEIO_API_KEY },
});
const { data } = await res.json();
console.log(data.monitor.status); // "paused"
import os
import requests
res = requests.post(
"https://api.uptimeio.com/api/monitors/MONITOR_ID/pause",
headers={"X-API-Key": os.environ["UPTIMEIO_API_KEY"]},
)
print(res.json()["data"]["monitor"]["status"])
Was this page helpful?