Skip to main content

Receiving a list of cameras by an external system by id

Getting a list of cameras by id.

Maximum 30 pieces.

GET /api/v1/billing/cameras/list

Headers

Accept

application/json

Response

200

Successful response

JSON
[
    {
        "id": 3,
        "camera_id": 3,
        "start_at": null,
        "status": "active",
        "name": "Parking on the left",
        "streams": [
            {
                "type": "high",
                "status": "active",
                "camera_id": 3
            },
            {
                "type": "low",
                "status": "active",
                "camera_id": 3
            }
        ],
        "preview": "https://server1.domain.video:8443/live/a2aefb0f-d3f7-4fb7-9828-218badead1f4/preview.mp4?token=xUXC_FOaJBQkSaxyZMBG77zC9pgULKSjA-EShnSzQbM-h7ePl8h76Dd20CYwTVihT2QzHZSX9d1DCPs8ttooqfzdgJb1RltcR1l3DgCmfFz68UUX_xEkGKNWbt5UPakGQXr5h1yMP7WE-CZ8CGqU6g~~"
    },
    {
        "id": 4,
        "camera_id": 4,
        "start_at": null,
        "status": "active",
        "name": "Parking on the right",
        "streams": [
            {
                "type": "high",
                "status": "active",
                "camera_id": 4
            },
            {
                "type": "low",
                "status": "active",
                "camera_id": 4
            }
        ],
        "preview": "https://domain.com:8443/live/67aa0ee2-1f32-4e8e-b383-ca02c87e8390/preview.mp4?token=sometoken"
    }
]
200

Cameras were not found

JSON
null
401

Authorization token not sent or not valid

422

Returns a JSON object with an error.

JSON
null

Example

JSON
curl -k --request POST \
	--url 'https://your-domain/api/v1/billing/cameras/list' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '[]'

Headers

Accept

application/json

Body

json

JSON
{
    "mac": "11:11:11:11:11:11"
}

macrequired

string

Camera MAC address

Response

204

Successful response

422

Returns a JSON object with an error. Validation

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

Example

JSON
curl -k --request POST \
	--url 'https://your-domain/api/v1/billing/cameras' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "mac": "11:11:11:11:11:11"
}'

JavaScript errors detected

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

If this problem persists, please contact our support.