Skip to main content
POST
/
api
/
v1
/
actions
Trigger an action on a bunch of devices.
curl --request POST \
  --url https://cloud.bytebeam.io/api/v1/actions \
  --header 'Content-Type: application/json' \
  --header 'x-bytebeam-api-key: <api-key>' \
  --header 'x-bytebeam-tenant: <api-key>' \
  --data '
{
  "params": {},
  "search_type": "<string>",
  "action": "<string>",
  "search_query": "<string>",
  "device_ids": [
    "<string>"
  ],
  "timeout": 123,
  "metadata": {},
  "search_key": "<string>"
}
'
{
  "id": 123,
  "created_at": "<string>",
  "phases": {
    "name": "<string>",
    "trigger_on": {}
  }
}

Authorizations

​
x-bytebeam-api-key
string
header
required

API key required to authenticate requests.

​
x-bytebeam-tenant
string
header
required

Tenant(Project) name required to identify the project.

Body

​
params
object
required
​
search_type
string
required
​
action
string
required
​
schedule
object
​
search_query
string
​
device_ids
string[]
​
timeout
integer<int64>
​
metadata
object
​
search_key
string

Response

​
id
integer<int64>
required
​
created_at
string
required
​
phases
object