Pause Monitor

Temporarily stop checking a monitor

Overview

Pause a monitor. Checks stop until you resume it. The monitor, its history and its settings are kept. Use this for planned maintenance on the monitored service.

POST https://api.uptimeio.com/api/monitors/{id}/pause

Authentication

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.

The request has no body.

Path parameters

Parameter	Type	Required	Description
id	UUID	Yes	Monitor ID.

Response

200 OK

Returns the updated monitor (same shape as Get Monitor). 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"
    }
  }
}

The example shows a subset of the fields that are returned.

Pausing and resuming are recorded in the monitor’s status history.

Errors

Status	Code	Cause
401	AUTHENTICATION_REQUIRED / MISSING_AUTH / INVALID_API_KEY	Missing or invalid credentials.
403	READ_ONLY_API_KEY	The key has read-only access.
404	MONITOR_NOT_FOUND	No monitor with this ID in the project.
500	MONITOR_PAUSE_FAILED	The monitor could not be paused.

Example

cURL

curl -X POST https://api.uptimeio.com/api/monitors/MONITOR_ID/pause \
  -H "X-API-Key: YOUR_API_KEY"