Skip to main content
POST
BatchDeleteMonitor

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ids
string[]

Monitors to delete. Each entry is the monitor's id, the UUID that ListMonitors returns, or the monitor's synq_path (monitor::<asset synq_path>::custom-<id>, or ad-<integration id>::<asset synq_path>::custom-<id> for an older monitor). A value in neither form is rejected with INVALID_ARGUMENT; a synq_path that names no monitor is reported in errors. A segment synq_path (a monitor synq_path followed by ::seg-<value>) names part of a monitor, so it deletes nothing and is reported in errors.

Minimum array length: 1

Response

200 - application/json

Success

deletedIds
string[]

Monitors that were deleted, each in the spelling the caller sent in ids: the id, or the synq_path. Every distinct monitor in the request appears once, either here or in errors.

errors
DeleteError · object[]

One entry per requested monitor that was not deleted, most commonly because no monitor with that id exists. Empty when every requested monitor was deleted.