Skip to main content
POST
Pause, resume or delete monitors
Pause, resume or delete many monitors at once, chosen by ids, by filter, or both. dry_run defaults to true, so the first call only lists what would change. Send "dry_run": false to apply the action.

Authorizations

X-API-Key
string
header
required

Your API key, such as keen_.... Create one in the Keenable console. If you send both this header and Authorization, the API uses this one.

Body

application/json

Send ids, a filter, or both. ids must list at least one monitor, and filter must set at least one of status, name and metadata. Otherwise the API returns 400.

action
enum<string>
required
Available options:
pause,
resume,
delete
ids
string[]
required
Required array length: 1 - 500 elements
filter
object
limit
integer
default:50

The most monitors to act on.

Required range: 1 <= x <= 500
dry_run
boolean
default:true

true (the default) only reports what would change. Send false to apply the action.

Response

What changed, or would change

action
string
required
affected
integer
required

Monitors the action applied to, or would apply to, including those already in that state.

ids
string[]
required
dry_run
boolean
required
has_more
boolean
required

true if more monitors matched than limit.

not_found
string[]
required

The ids that aren't your organization's monitors.