Skip to content
EyesOnItDocumentation6.1

Patch Runtime Settings

PATCH /api/v1/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.

The handler requires an EyesOnIt system administrator. Use an administrator user session for this operation.

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

Parameters

Section titled “Parameters”
Name Location Required Type Description and constraints
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 — PatchRuntimeSettingsBody.

Field Type Required Description and constraints
revision integer Yes minimum 1.0
archiveRetentionDays number or null No
auditRetentionDays number or null No
incidentRetentionDays number or null No
incidentSnapshotRetentionDays number or null No
evidenceClipRetentionDays number or null No
notificationDeliveryEnabled boolean or null No
notificationTimeoutSeconds number or null No
notificationMaximumAttempts integer or null No
recordingMaximumAttempts integer or null No
imageAnalysisMaximumAttempts integer or null No
maximumActiveSearches integer or null No
liveSearchTrackIntervalSeconds number or null No
liveSearchMaximumTrackCropsPerFrame integer or null No
liveSearchMaximumFaceCropsPerFrame integer or null No

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 PATCH \
  --cookie "${EOI_COOKIE_JAR}" \
  --header "X-EyesOnIt-Session-Id: ${EOI_SESSION_ID}" \
  --header "X-CSRF-Token: ${EOI_CSRF_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json \
  "${EOI_API_BASE_URL}/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 RuntimeSettingsResponse
422 Validation Error application/json HTTPValidationError

Operation identifier patchRuntimeSettings. Browse Settings and vault references.

Image preview