Devices

Batch Update Devices

Update multiple registered devices belonging to your organization in a single request.

Required Scope: write-devices

Overview

  • A maximum of 1000 devices can be updated in a single request.
  • Each update is idempotent. In the event of an internal error (i.e. 5xx) some updates may be applied and others may not. Each update is idempotent and the whole request can be retried again to ensure a consistent update across the batch.
patch/v2/org/{org_id}/devices

Request

  • Base URL: https://api.hubble.com
  • URL: https://api.hubble.com/v2/org/{org_id}/devices
  • Auth: HTTP bearer

Path parameters

org_idstring uuid required

The ID for an organization

Your organization ID

Request body

Example request

{
  "updates": [
    {
      "set_tags": {
        "_env": "production"
      },
      "set_destination_org_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Response

Updated Devices

Example response

{
  "devices": [
    {
      "tags": {
        "_env": "production"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.