Get the list of devices - paginated.

GET /api/v1/devices

Try it

Get the list of devices - paginated.

cURL

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

200

[
  {
    "id": 123,
    "metadata": {},
    "state": {},
    "status": "inactive",
    "action": {},
    "-serial_metadata": {}
  }
]

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.

Query Parameters

page · string

limit · string

status · enum<string>

Available options: all, inactive, active

action-id · integer<int64>

sortkey · string

sortorder · enum<string>

Available options: desc, asc

Response

200

application/json

List of devices

id · integer<int64> · required

metadata · object · required

Show child attributes

metadata. {key} · string | null

state · object · required

Show child attributes

state. {key} · object

status · enum<string> · required

Available options: inactive, active

action · object · required

-serial_metadata · object

Show child attributes

-serial_metadata. {key} · string