Получить список устройств Bridge

Список устройств

Пагинированный список всех устройств, доступных в системе. Устройства (бриджи) - это софт, который используется для предоставления доступа к камерам, к которым нет доступа для медиа сервера напрямую (находятся во внутренней сети) Permission - bridges

GET api/admin/v1/bridges

Параметры метода

string search, Поиск осуществляется по серийному номеру или MAC-адресу устройства

bool is_online, Фильтрация устройств по статусу онлайна, 1 - онлайн, 0 - оффлайн.

int per_page, Кол-во элементов в одной странице пагинации. По умолчанию 25 элементов

string sort, Поле, по которому осуществляется сортировка устройств

string dir, Поле, в котором указывается направлении сортировки. desc - от большего к меньшему, asc - от меньшего к большему

array user_ids, Массив из id пользователей, данное поле служит для фильтрации бриджей по принадлежности к пользователям.

int page, Номер страницы пагинации

200 OK

Возвращает список бриджей на i странице пагинации

JSON

{
    "data": [
        {
            "id": 1,
            "serial_number": "12345678",
            "mac": "00-B0-D0-63-C2-26",
            "name": "bridge_1",
            "version": "1.0.1",
            "created_at": "2023-09-18T17:34:29.000000Z",
            "last_updated_at": "2023-09-18T17:34:54.000000Z",
            "is_online": true
        }
    ],
    "links": {
        "first": "https://vms.local:8000/api/admin/v1/bridges?page=1",
        "last": "https://vms.local:8000/api/admin/v1/bridges?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local:8000/api/admin/v1/bridges?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local:8000/api/admin/v1/bridges",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}

401 Unauthorized

Токен авторизации не передан или не валидный

422 Unprocessable Entity

Возвращает JSON объект с ошибкой.

JSON

{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}

cURL

BASH

curl -k --request POST \
	--url 'https://your-domainapi/admin/v1/bridges' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "search": "string",
    "is_online": true,
    "per_page": 0,
    "sort": "string",
    "dir": "string",
    "user_ids": [],
    "page": 0
}'

PHP

$data = array (
  'search' => 'string',
  'is_online' => true,
  'per_page' => 0,
  'sort' => 'string',
  'dir' => 'string',
  'user_ids' => 
  array (
  ),
  'page' => 0,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domainapi/admin/v1/bridges', false, $context);