Skip to main content
POST
/
devices
/
batch
/
state
Batch change device state
curl --request POST \
  --url https://dashboard.hologram.io/api/1/devices/batch/state \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "<string>",
  "deviceids": [
    123
  ],
  "deviceFilters": {}
}
'
{
  "success": true,
  "data": {
    "jobid": 123,
    "preview": true,
    "valid_tasks": [
      {}
    ]
  }
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Body

application/json
​
state
string
required

New state: pause, live, or deactivate

​
deviceids
integer[]

List of device IDs to update

​
deviceFilters
object

Bulk selection filter criteria (alternative to deviceids)

Response

OK

​
success
boolean

Indicates whether the request was successful.

Example:

true

​
data
object