---
title: "Toggle pause state for a monitor"
method: POST
path: "/monitors/pause/{monitorId}"
tags: ["monitors"]
---

# Toggle pause state for a monitor

`POST /monitors/pause/{monitorId}`

## Path parameters

- `monitorId` string, required

## Response `200`

OK

- object
  - `success` true, required
  - `msg` string, required
  - `data` Monitor, required
    - `_id` string, required
    - `name` string, required
    - `description` string
    - `type` 'http' | 'ping' | 'pagespeed' | 'hardware' | 'docker' | 'port' | 'game' | 'grpc' | 'websocket' | 'dns' | 'unknown', required
    - `url` string, required
    - `port` number
    - `isActive` boolean, required
    - `interval` number, required
    - `status` 'up' | 'down' | 'paused' | 'initializing' | 'maintenance' | 'breached', required
    - `statusWindowSize` number, required
    - `statusWindowThreshold` number, required
    - `ignoreTlsErrors` boolean, required
    - `useAdvancedMatching` boolean, required
    - `jsonPath` string
    - `expectedValue` string
    - `matchMethod` 'equal' | 'include' | 'regex'
    - `notifications` string[], required
    - `tags` string[], required
    - `secret` string
    - `cpuAlertThreshold` number, required
    - `memoryAlertThreshold` number, required
    - `diskAlertThreshold` number, required
    - `tempAlertThreshold` number, required
    - `selectedDisks` string[], required
    - `gameId` string
    - `grpcServiceName` string
    - `group` string, nullable
    - `geoCheckEnabled` boolean, required
    - `geoCheckLocations` string[], required
    - `geoCheckInterval` number, required
    - `dnsServer` string
    - `dnsRecordType` 'A' | 'AAAA' | 'CNAME' | 'MX' | 'TXT' | 'NS'
    - `teamId` string, required
    - `userId` string, required
    - `createdAt` string, required
    - `updatedAt` string, required

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal server error

## Changes

- **2026-05-27** `dd1708803c7c` — 1 info
  - added the required property `data/tags` to the response with the `200` status
- **2026-05-11** `59d86e7d3831` — 1 warning, 2 info
  - added the new `dns` enum value to the `data/type` response property for the response status `200`
  - added the optional property `data/dnsRecordType` to the response with the `200` status
  - added the optional property `data/dnsServer` to the response with the `200` status
- **2026-05-01** `39082d385dda` — 1 breaking, 3 warning, 38 info
  - for the `path` request parameter `monitorId`, the minLength was increased from `0` to `1`
  - removed the optional property `details` from the response with the `500` status
  - added the new `false` enum value to the `success` response property for the response status `500`
  - added the new `true` enum value to the `success` response property for the response status `200`
  - …38 more
- **2025-08-11** `db719f9e3d34` — 9 info
  - added the non-success response with the status `404`
  - removed the non-success response with the status `422`
  - added the optional property `details` to the response with the `500` status
  - the response property `msg` became required for the status `200`
  - …5 more
- …earlier changes not shown

[Full history](https://skmtc.dev/bluewave-labs/apis/checkmate-api/changes/monitors/pause/:monitorId/post.md)

---

[API](https://skmtc.dev/bluewave-labs/apis/checkmate-api.md) · [All operations](https://skmtc.dev/bluewave-labs/apis/checkmate-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bluewave-labs/checkmate-api/revisions/0ecdfd20a742/schema)