Skip to main content
Skip table of contents

Camera configurations

Camera configurations

List of configurations applied to the camera

GET /api/admin/v1/camera/{camera}/configs

Method parameters

int camera, unique identifier of the camera


int per_page, number of items per pagination page. Default is 25


int page, pagination page number


integer user_id, user ID


string type, configuration type


string applying_type, method by which the configuration was applied


string status, configuration status


date from, start of the time interval


date to, end of the time interval

200 OK

Returns a list of camera configurations on the i pagination page

JSON
{
    "data": [
        {
            "id": 58,
            "type": "VideoEncoder_First",
            "body": "{\"Name\":\"VideoEncoder_1\",\"UseCount\":2,\"token\":\"VideoEncoderToken_1\",\"Encoding\":\"H265\",\"Resolution\":{\"Width\":1920,\"Height\":1080},\"RateControl\":{\"FrameRateLimit\":25,\"BitrateLimit\":1024,\"ConstantBitRate\":true},\"Multicast\":{\"Address\":{\"Type\":\"IPv4\",\"IPv4Address\":\"0.0.0.0\"},\"Port\":8860,\"TTL\":1,\"AutoStart\":false},\"Quality\":3,\"GovLength\":29,\"Profile\":\"High\"}",
            "name": "main to high",
            "description": null,
            "service": "Any",
            "vendor": "HIKVISION",
            "model": "DS-2CD1123G0E-I",
            "is_default": 0,
            "pivot": {
                "user_id": 1,
                "type": "user",
                "status": "actual",
                "reason": null,
                "created_at": "2022-06-22 14:08:44",
                "updated_at": "2022-06-22 14:08:44"
            }
        }
    ],
    "links": {
        "first": "https://vms.local/api/admin/v1/camera/749/configs?page=1",
        "last": "https://vms.local/api/admin/v1/camera/749/configs?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/api/admin/v1/camera/749/configs?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/admin/v1/camera/749/configs",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

401 Unauthorized

Authorization token is not provided or is invalid. Obtaining a token

cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/camera/{camera}/configs' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "camera": 0,
    "per_page": 0,
    "page": 0,
    "user_id": "integer",
    "type": "string",
    "applying_type": "string",
    "status": "string",
    "from": "date",
    "to": "date"
}'
PHP
PHP
$data = array (
  'camera' => 0,
  'per_page' => 0,
  'page' => 0,
  'user_id' => 'integer',
  'type' => 'string',
  'applying_type' => 'string',
  'status' => 'string',
  'from' => 'date',
  'to' => 'date',
);
$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/admin/v1/camera/{camera}/configs', false, $context);
JavaScript errors detected

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

If this problem persists, please contact our support.