Skip to main content

​
Overview

Pause a monitor to temporarily stop all monitoring checks. Paused monitors do not trigger alerts or record check results but retain all configuration. Resume the monitor at any time to restart checks.

​
Authentication

All requests must include authentication via:
  • API Key: X-API-Key: YOUR_API_KEY

​
Path Parameters

ParameterTypeRequiredDescription
idstringYesMonitor UUID (e.g., mon_1234567890abcdef)

​
Request Example

POST /api/monitors/mon_1234567890abcdef/pause
No request body is required.

​
Request Details

AspectValue
Content-TypeNot required (no body)
BodyEmpty
Query ParametersNone

​
Response

​
Success Response (200 OK)

{
  "success": true,
  "data": {
    "id": "mon_1234567890abcdef",
    "organization_id": "org_1234567890abcdef",
    "project_id": "proj_1234567890abcdef",
    "name": "Production API Health",
    "type": "HTTP",
    "target": "https://api.example.com/health",
    "interval_seconds": 60,
    "timeout_ms": 10000,
    "status": "paused",
    "monitoring_regions": ["asia", "europe"],
    "tags": ["production", "critical"],
    "http_config": {
      "method": "GET",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      },
      "follow_redirects": true,
      "max_redirects": 5,
      "expected_status_codes": [200, 201]
    },
    "notification_profile_ids": ["uuid-1", "uuid-2"],
    "created_at": "2024-12-26T10:30:00Z",
    "updated_at": "2024-12-26T15:45:30Z",
    "created_by": "user_1234567890abcdef",
    "is_deleted": false,
    "is_active": false
  }
}

​
Pause Effects

When a monitor is paused:
  1. Check Scheduling: No new checks are scheduled
  2. Existing Checks: In-flight checks complete but results are not recorded
  3. Notifications: No alerts or notifications are sent
  4. Data Recording: No new check results added to historical data
  5. Configuration: All settings remain unchanged
  6. Status: Monitor appears as paused in queries
  7. Plan Limits: Monitor still counts towards active monitor limit

​
When to Pause

Consider pausing monitors for:
  • Maintenance: During scheduled system maintenance windows
  • Testing: When testing application changes
  • Temporary Issues: When addressing known problems
  • Cost Control: To pause monitoring without deleting configuration
  • Deployment: During application deployments

​
Pausing vs. Deleting

AspectPauseDelete
Configuration RetainedYesYes
Counts Toward LimitYesNo
Can ResumeYesNo (soft-deleted)
Visible in ListsNoNo
Historical DataAccessibleArchived
Notifications SentNoNo

​
Error Codes

CodeStatusDescription
INVALID_MONITOR_ID400Missing or invalid monitor ID
AUTHENTICATION_REQUIRED401Missing or invalid authentication
MONITOR_NOT_FOUND404Monitor not found or access denied
MONITOR_PAUSE_FAILED500Unexpected pause failure

​
Examples

# Pause a monitor
curl -X POST https://api.uptimeio.com/api/monitors/mon_1234567890abcdef/pause \
  -H "X-API-Key: YOUR_API_KEY"