Skip to content
EyesOnItDocumentation6.1

Set edge device settings

PUT /api/v1/edge-devices/{device_id}/settings

Access

Section titled “Access”

Authentication options declared in the contract include user cookie session or bearer service token.

The shared authentication policy requires system:manage. Resource access also depends on the caller’s role, organization, camera grants, and the operation’s validation.

User-session writes require recent authentication.

Authentication and permissions explains tokens, cookies, CSRF, and workspace context.

Parameters

Section titled “Parameters”
Name Location Required Type Description and constraints
device_id path Yes string (uuid)
If-Match header Yes integer (int64) minimum 1. maximum 9007199254740991
X-EyesOnIt-Session-Id header No string (uuid) The sessionId the caller expects. Required when switching workspaces and for cookie requests after workspace rotation. A mismatched value returns 409 with X-EyesOnIt-Workspace-Changed: 1. Bootstrap with getCurrentPrincipal; never replay a mutation automatically after changing context. Bearer clients do not use this header.
X-CSRF-Token header No string Required for unsafe requests authenticated by CookieSession; ignored for bearer clients. minimum length 32. maximum length 256

Request body

Section titled “Request body”

Required.

application/json — EdgeSettings.

Field Type Required Description and constraints
axis AxisEdgeSettings or null No
catchupEnabled boolean No Allow historical screening, archive reconstruction and selected historical uploads. Pausing catch-up preserves retained history and continuous recording. default true
retentionDays integer No minimum 1.0. maximum 3650.0. default 30
maximumRetentionDays integer No minimum 1.0. maximum 3650.0. default 365
maximumPendingBytes integer (int64) No minimum 1.0. maximum 9007199254740991.0. default 10000000000
maximumUploadBitsPerSecond integer (int64) No minimum 64000.0. maximum 10000000000.0. default 20000000
maximumCatchupBitsPerSecond integer (int64) No minimum 64000.0. maximum 10000000000.0. default 5000000

cURL request template

Section titled “cURL request template”

Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. Prepare the body file using the request schema above. This template sends the request when run.

Terminal window
curl --fail-with-body --silent --show-error \
  --request PUT \
  --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
  --header "If-Match: ${EOI_IF_MATCH}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json \
  "${EOI_API_BASE_URL}/edge-devices/${EOI_DEVICE_ID}/settings"

Contract responses

Section titled “Contract responses”

The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.

Status Description Media type Body
200 Successful Response application/json EdgeDeviceResponse
422 Validation Error application/json HTTPValidationError

Operation identifier setEdgeDeviceSettings. Browse Devices.

Image preview