Retrieve a list of Bridge devices

Device list

Paginated list of all devices available in the system. Devices (bridges) are software that is used to provide access to cameras that are not directly accessible to the media server (located on the internal network) Permission - bridges

GET api/admin/v1/bridges

string search, Search is carried out by serial number or MAC address of the device

bool is_online, Filtering devices by online status, 1 - online, 0 - offline.

int per_page, Number of elements in one pagination page.

string sort, Field by which devices are sorted

string dir, A field that specifies the sorting direction.

array user_ids, An array of user ids, this field is used to filter bridges by user affiliation.

int page, Pagination page number

200 OK

Returns a list of bridges on the i pagination page

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

Authorization token not sent or not valid

422 Unprocessable Entity

Returns a JSON object with an error.

JSON

{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The cause of the error will be described here"
        ]
    }
}

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);