Client camera with the integrated Agent software. Pause streams

Pause streams

Permission - camera-agents

Possible values for the is_enabled field:

true - Streams active
false - Streams paused

POST /api/v1/camera-agents/{camera_agent}/pause

Parameters

int camera_agent, Unique device identifier.

200 OK

Returns the object of camera agent

JSON

{
    "id": 1,
    "name": "name",
    "uuid": "uuid-jjdla-aa2",
    "mac": "mac",
    "serial_number": "serial_number",
    "status": "activated",
    "is_online": true,
    "version": "25.12.22",
    "last_updated_at": "2024-02-07T12:40:48.000000Z",
    "created_at": "2024-02-07T12:40:48.000000Z",
    "updated_at": "2024-02-07T12:40:48.000000Z",
    "camera": {
        "id": 1,
        "group_id": 1,
        "status": "active",
        "type": "media_server_v2",
        "start_at": null,
        "created_at": "2023-09-07T10:29:01.000000Z",
        "billing_id": null,
        "pretty_name": "camera_agent",
        "original_name": "camera_agent",
        "lat": 56.850222,
        "lng": 22.630765,
        "latitude": 56.850222,
        "longitude": 22.630765,
        "is_location_editable": false,
        "azimuth": null,
        "archive_recording_type": "fulltime",
        "can_change_archive_timetable": false,
        "is_bridge": true,
        "is_intercom": false,
        "is_enabled": false,
        "is_cloud_archive_enabled": false,
        "is_local_archive_enabled": false,
        "cloud_archive_storage_days": 1,
        "local_archive_storage_days": null,
        "ip": "127.0.0.1",
        "is_favorite": false,
        "is_restricted_live": null,
        "is_restricted_archive": null,
        "user_status": "active",
        "note": null,
        "name": "camera_agent"
    }
}

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/camera-agents/{camera_agent}/pause' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "camera_agent": 0
}'

PHP

$data = array (
  'camera_agent' => 0,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/camera-agents/{camera_agent}/pause', false, $context);