EXexa
Monitors

Batch action on monitors

Changed on

Deletes, pauses, or unpauses the monitors that match the filter. Deletion is permanent. dry_run defaults to true, so a request only previews the affected monitors unless you set it to false. Repeat the request until has_more is false to process all matches.

post/monitors/batch

Request

  • Base URL
    https://api.exa.ai
  • URL
    https://api.exa.ai/monitors/batch
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

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.

Changes