Camera Set

PUT 
/camera/:camera_name/set/:feature

Access: Admin role required.

Set a camera feature state. Use camera_name='*' to target all cameras.

The value to set is sent in the request body as {"value": "<value>"}.

Feature	Accepted values
enabled	ON, OFF
detect	ON, OFF
motion	ON, OFF
recordings	ON, OFF
snapshots	ON, OFF
audio	ON, OFF
audio_transcription	ON, OFF
notifications	ON, OFF
review_alerts	ON, OFF
review_detections	ON, OFF
object_descriptions	ON, OFF
review_descriptions	ON, OFF
improve_contrast	ON, OFF
ptz_autotracker	ON, OFF
birdseye	ON, OFF
birdseye_mode	CONTINUOUS, MOTION, OBJECTS
motion_contour_area	integer
motion_threshold	integer
motion_mask	ON, OFF
object_mask	ON, OFF
zone	ON, OFF
profile	a profile name, or none to deactivate

motion_mask, object_mask, and zone require the sub_command path parameter to be set to the name of the mask or zone. All other features reject a sub-command.

profile applies globally rather than per camera, so it requires camera_name to be *.

These features map to the equivalent MQTT topics, which document the behavior of each value in more detail.

Request

Responses

200

Successful Response

422

Validation Error