Update PTZ patrols

Replaces the complete patrol configuration; this is not a merge. All three fields are required.
Omitted sequences and steps are removed. Sequence names must be nonblank, and the active name must match
a nonempty submitted sequence or be null. Each step requires a camera presetToken string as returned by
the presets list and a positive integer dwellTimeSec; do not use a Cloud _id or HOME.

Use null to save without an active patrol. To clear all patrols, send {}, false and null. To disable patrols
while keeping their sequences, send the complete existing map, false and null.

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.

Required scope: write:ptz

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
ptzPatrolSequences
object
required

Complete replacement of the named patrol sequences. Each step takes a presetToken as returned by GET presets (never a Cloud _id or HOME) and a positive integer dwellTimeSec.

boolean
required

Explicit patrol enable flag. Use false and a null active name to disable while retaining the submitted sequences.

string | null
required

Required. Exact name of a nonempty submitted sequence, or null for no active selection.

Responses

429

Too many requests. Try again later.

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