Skip to main content
GET
/
api
/
v1
/
devices
Get the list of devices - paginated.
curl --request GET \
  --url https://cloud.bytebeam.io/api/v1/devices \
  --header 'x-bytebeam-api-key: <api-key>' \
  --header 'x-bytebeam-tenant: <api-key>'
[
  {
    "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
​
sortkey
string
​
sortorder
enum<string>
Available options:
desc,
asc

Response

List of devices

​
id
integer
required
​
metadata
object
required
​
state
object
required
​
status
enum<string>
required
Available options:
inactive,
active
​
action
object
required
​
-serial_metadata
object