Get device actions given device id

GET /api/v1/devices/{device_id}/actions

Try it

Get device actions given device id

cURL

curl --request GET \
  --url https://cloud.bytebeam.io/api/v1/devices/{device_id}/actions \
  --header 'x-bytebeam-api-key: <api-key>' \
  --header 'x-bytebeam-tenant: <api-key>'

200

{
  "device_actions": [
    {
      "action_status": "<string>",
      "errors": {},
      "phase": 123,
      "action_id": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "device_id": {},
      "progress": 123,
      "params": "<string>",
      "type": "<string>",
      "user_email": "<string>",
      "-serial_metadata": {},
      "user_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123
}

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.

Path Parameters

device_id · integer<int64> · required

Query Parameters

sort_order · enum<string>

Available options: desc, asc

action_ids · string

incomplete · boolean

limit · integer<int64>

page · integer<int64>

action_types · string

sort_column · enum<string>

Available options: errors, type, user_email, action_id, updated_at, status, user_name

creators · string

Response

200

application/json

device_actions · object[] · required

Show child attributes

device_actions. action_status · string · required

device_actions. errors · object · required

device_actions. phase · integer<int64> · required

device_actions. action_id · integer<int64> · required

device_actions. updated_at · string<date-time> · required

device_actions. status · string · required

device_actions. device_id · object · required

device_actions. progress · integer<int64> · required

device_actions. params · string

device_actions. type · string

device_actions. user_email · string

device_actions. -serial_metadata · object

Show child attributes

device_actions.-serial_metadata. {key} · string

device_actions. user_name · string

device_actions. created_at · string<date-time>

count · integer<int64> · required