Get the list of devices - paginated.

GET /api/v1/devices

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>'

import requests

url = "https://cloud.bytebeam.io/api/v1/devices"

headers = {
    "x-bytebeam-api-key": "<api-key>",
    "x-bytebeam-tenant": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-bytebeam-api-key': '<api-key>', 'x-bytebeam-tenant': '<api-key>'}
};

fetch('https://cloud.bytebeam.io/api/v1/devices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.bytebeam.io/api/v1/devices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-bytebeam-api-key: <api-key>",
    "x-bytebeam-tenant: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.bytebeam.io/api/v1/devices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-bytebeam-api-key", "<api-key>")
	req.Header.Add("x-bytebeam-tenant", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://cloud.bytebeam.io/api/v1/devices")
  .header("x-bytebeam-api-key", "<api-key>")
  .header("x-bytebeam-tenant", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.bytebeam.io/api/v1/devices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-bytebeam-api-key"] = '<api-key>'
request["x-bytebeam-tenant"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

[
  {
    "id": 123,
    "metadata": {},
    "state": {},
    "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

state · object · required

Show child attributes

status · enum<string> · required

Available options: inactive, active

action · object · required

-serial_metadata · object

Show child attributes