Skip to main content
POST
/
api
/
v1
/
monitors
/
bulk
Bulk action on monitors
curl --request POST \
  --url https://api.devhelm.io/api/v1/monitors/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "monitorIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "action": "PAUSE",
  "tagIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "newTags": [
    {
      "name": "<string>",
      "color": "<string>"
    }
  ]
}
'
{
  "data": {
    "succeeded": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "failed": [
      {
        "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "reason": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Body

application/json

Request body for performing a bulk action on multiple monitors

​
monitorIds
string<uuid>[]
required

IDs of monitors to act on (max 200)

Maximum array length: 200

IDs of monitors to act on (max 200)

​
action
enum<string>
required

Action to perform: PAUSE, RESUME, DELETE, ADD_TAG, REMOVE_TAG

Available options:
PAUSE,
RESUME,
DELETE,
ADD_TAG,
REMOVE_TAG
​
tagIds
(string<uuid> | null)[] | null

Tag IDs to attach or detach (required for ADD_TAG and REMOVE_TAG)

Tag IDs to attach or detach (required for ADD_TAG and REMOVE_TAG)

​
newTags
object[] | null

New tags to create and attach (only for ADD_TAG)

Response

200 - */*

OK

​
data
object

Result of a bulk monitor action, including partial-success details