Sign in

v1

OpenAPI 3.1.02026-08-0458114534.0 KB
Monitors

Batch Action on Monitors

Perform a batch action on monitors matching the provided filters.

Supported actions:

  • delete: Permanently remove matching monitors
  • pause: Pause matching monitors
  • unpause: Unpause matching monitors

Use dry_run: true (the default) to preview which monitors would be affected before performing the action. Results are paginated via the limit parameter; loop until has_more is false to process all matching monitors.

post/monitors/batch

Request body

action'delete' | 'pause' | 'unpause' required

The action to perform on matching monitors. delete permanently removes them, pause sets their status to paused, and unpause sets their status to active.

dry_runboolean

When true, returns the monitors that would be affected without performing the action. Defaults to true.

limitinteger

Maximum number of monitors to process in a single request. Defaults to 50, maximum 500.

Response

Batch action result

action'delete' | 'pause' | 'unpause' required

The action that was performed

affectedinteger required

The number of monitors affected by the action

idsstring[] required

The IDs of the monitors that were affected

dry_runboolean required

Whether this was a dry run

has_moreboolean required

Whether there are more monitors matching the filter. If true, repeat the request to process the next batch.