Skip to main content
Skip table of contents

Get a list of client bridges

Device list

A paginated list of all devices available to the user. 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/v1/bridges

Parameters

int page, Pagination page number


int per_page, Number of elements in one pagination page.

200 OK

Returns a list of bridges on the i pagination page

JSON
{
    "data": [
        {
            "id": 1,
            "name": "bridge_1",
            "uuid": "ac5cf4bf-0e3f-481a-a8d9-f8aee1cc2629",
            "serial_number": "serial_number",
            "mac": "qweasdzxc",
            "status": "activated",
            "is_online": true,
            "created_at": "2023-08-03T14:16:13.000000Z",
            "updated_at": "2023-08-03T14:16:13.000000Z"
        }
    ],
    "links": {
        "first": "https://vms.local:8080/api/v1/bridges?page=1",
        "last": "https://vms.local:8080/api/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:8080/api/v1/bridges?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local:8080/api/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-domain/api/v1/bridges' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "page": 0,
    "per_page": 0
}'
PHP
PHP
$data = array (
  'page' => 0,
  'per_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-domain/api/v1/bridges', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.