Get a list of client cameras. Agent-compatible cameras

The method and parameters

A paginated list of all devices available to the user. Devices (camera-agent) are software that is used to provide access to camera that is not directly accessible to the media server (located on the internal network) Permission - camera-agents

GET /api/v1/camera-agents

Parameters

int page, Pagination page number

int per_page, Number of elements in one pagination page.

200 OK

Returns a list of devices on the i pagination page

JSON

{
    "data": [
        {
            "id": 1,
            "name": "camera_agent_1",
            "uuid": "50b54973-dac0-4964-bdad-38640e23255b",
            "mac": "qweasdzxc",
            "serial_number": "serial_number",
            "status": "activated",
            "is_online": true,
            "version": null,
            "last_updated_at": null,
            "created_at": "2024-05-17T11:45:17.000000Z",
            "updated_at": "2024-05-17T11:45:17.000000Z"
        }
    ],
    "links": {
        "first": "https://vms.local:8080/api/v1/camera-agents?page=1",
        "last": "https://vms.local:8080/api/v1/camera-agents?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/camera-agents?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local:8080/api/v1/camera-agents",
        "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 GET \
	--url 'https://your-domain/api/v1/camera-agents' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "page": 0,
    "per_page": 0
}'

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/camera-agents', false, $context);