Updates multiple devices (server objects).

Updates multiple devices (server objects) in a batch. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
query Parameters
o
required
integer

Organization ID for the specified devices

Request Body schema: application/json
required
devices
required
Array of integers [ 1 .. 500 ] items

List of device (server) IDs

required
Array of objects

Array of different actions to take on each device

Array
attribute
string

Name of the attribute

Value: "tags"
action
string

What action should be taken

Enum: "apply" "remove"
value
Array of strings

The value to use for the action

Responses
200

Successful operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

503

Service Unavailable

default

Invalid Request

post/servers/batch
Request samples
application/json
{
  • "devices": [
    • 654321
    ],
  • "actions": [
    • {
      • "attribute": "tags",
      • "action": "apply",
      • "value": [
        • "My Test Tag",
        • "Windows Servers"
        ]
      }
    ]
}
Response samples
application/json
{
  • "summary": "Batch job example",
  • "description": "Example of a batch job status with progress information and queue details",
  • "value": {
    • "id": "9f13ba91-b73f-4860-9008-712574a8fd39",
    • "total_jobs": 1,
    • "pending_jobs": 1,
    • "processed_jobs": 0,
    • "progress": 0,
    • "failed_jobs": 0,
    • "options": {
      • "queue": "device-updates"
      },
    • "created_at": "2025-06-04T21:00:33.000000Z",
    • "cancelled_at": null,
    • "finished_at": null
    }
}