Skip to main content
Get all devices
curl --request GET \
  --url https://api.example.com/api/devices
import requests

url = "https://api.example.com/api/devices"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/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://api.example.com/api/devices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/api/devices"

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/devices")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/devices")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
[
  {
    "controls": [
      {
        "flags": {
          "default_value": 123,
          "max_value": 123,
          "min_value": 123,
          "step": 123,
          "menu": [
            {
              "index": 123,
              "name": "<string>"
            }
          ]
        },
        "control_id": 123,
        "name": "<string>",
        "value": 123
      }
    ],
    "stream": {
      "device_path": "<string>",
      "endpoints": [
        {
          "host": "<string>",
          "port": 123
        }
      ],
      "width": 123,
      "height": 123,
      "interval": {
        "numerator": 123,
        "denominator": 123
      },
      "enabled": true
    },
    "vid": 123,
    "pid": 123,
    "bus_info": "<string>",
    "nickname": "<string>",
    "cameras": [
      {
        "path": "<string>",
        "formats": {}
      }
    ],
    "name": "<string>",
    "manufacturer": "<string>",
    "device_info": {
      "device_name": "<string>",
      "bus_info": "<string>",
      "device_paths": [
        "<string>"
      ],
      "vid": 123,
      "pid": 123
    },
    "followers": [],
    "is_managed": false,
    "frame_stats": {
      "num_drops": 0
    }
  }
]

Response

200 - application/json

Successful Response

controls
ControlModel · object[]
required
stream
StreamModel · object
required
vid
integer
required
pid
integer
required
bus_info
string
required
nickname
string
required
device_type
enum<integer>
required

Device type Enum

Available options:
0,
1,
2,
3,
4
cameras
CameraModel · object[] | null
name
string | null
manufacturer
string | null
device_info
DeviceInfoModel · object | null
followers
string[]
is_managed
boolean
default:false
frame_stats
FrameDropStats · object