Set active PTZ patrol

Sets the active saved patrol by exact name. Send {"activeSequenceName":null} to clear the selection;
saved sequences are not changed. Selecting a patrol derives ptzPatrolEnabled from whether any saved
sequence has steps. Clearing the selection can therefore leave patrols enabled with no active sequence;
use PUT patrols to change the enabled flag explicitly.

Clearing the selection does not stop the camera immediately. Use the PTZ command endpoint's stop action
for an emergency stop.

The endpoint waits for the edge device. HTTP 200 with state=0 confirms the update; HTTP 202 with
EDGE_RESULT_UNKNOWN does not. After a 202 or connection loss, reconcile the saved configuration with
the camera before retrying.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Camera identifier from the Cameras API; must belong to the API-key organization.

Body Params
string | null
required

Required. Exact name of an existing nonempty sequence, or null to clear the active selection. This does not delete saved sequences.

Responses

429

Too many requests. Try again later.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json