Skip to main content
POST
/
devices
/
{deviceId}
/
state
Pause, resume, or deactivate device
curl --request POST \
  --url https://dashboard.hologram.io/api/1/devices/{deviceId}/state \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "pause",
  "priority": 123
}
'
{
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.hologram.io/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

​
deviceId
integer
required

ID of the device

Body

application/json
​
state
string
required

New state: pause, live, or deactivate

Example:

"pause"

​
priority
integer

Carrier backend priority for this state change (super admin only)

Response

OK

​
success
boolean

Indicates whether the request was successful.

Example:

true