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"
  ],
  "tagIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "newTags": [
    {
      "name": "<string>",
      "color": "<string>"
    }
  ]
}
'
import requests

url = "https://api.devhelm.io/api/v1/monitors/bulk"

payload = {
    "monitorIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "tagIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "newTags": [
        {
            "name": "<string>",
            "color": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    monitorIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    tagIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    newTags: [{name: '<string>', color: '<string>'}]
  })
};

fetch('https://api.devhelm.io/api/v1/monitors/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.devhelm.io/api/v1/monitors/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'monitorIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'tagIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'newTags' => [
        [
                'name' => '<string>',
                'color' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.devhelm.io/api/v1/monitors/bulk"

	payload := strings.NewReader("{\n  \"monitorIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"newTags\": [\n    {\n      \"name\": \"<string>\",\n      \"color\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.devhelm.io/api/v1/monitors/bulk")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"monitorIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"newTags\": [\n    {\n      \"name\": \"<string>\",\n      \"color\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.devhelm.io/api/v1/monitors/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"monitorIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"newTags\": [\n    {\n      \"name\": \"<string>\",\n      \"color\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "succeeded": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "failed": [
      {
        "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "reason": "<string>"
      }
    ]
  }
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}

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 apply to every monitor in the bulk request

Available options:
PAUSE,
RESUME,
DELETE,
ADD_TAG,
REMOVE_TAG
tagIds
string<uuid>[] | 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

OK

data
object
required

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