Skip to content
EyesOnItDocumentation6.1

Replace Stream Analytics

PUT /api/v1/streams/{streamId}/analytics

Replace only the analytics scene with If-Match stream revision protection. Customer edits require delegated analytics permission. Connections, names, monitoring state, recording, indexing, sampling, and face-recognition resources remain provider-controlled. Customer scenes may use recording actions and authorized notification profiles; raw webhook and Genetec transports are provider-only. Disabled scene references are also checked. Current authority, references, the new revision, and audit commit in one durable transaction.

Access

Section titled “Access”

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

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

User-session writes require recent authentication.

Analytics access requires an administrator user session or a permitted customer user with camera analytics delegation.

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

Parameters

Section titled “Parameters”
Name Location Required Type Description and constraints
streamId path Yes string (uuid)
If-Match header Yes integer minimum 1
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 — ReplaceStreamAnalyticsBody.

Field Type Required Description and constraints
scene StreamSceneModel Yes

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 \
  --cookie "${EOI_COOKIE_JAR}" \
  --header "X-EyesOnIt-Session-Id: ${EOI_SESSION_ID}" \
  --header "X-CSRF-Token: ${EOI_CSRF_TOKEN}" \
  --header "If-Match: ${EOI_IF_MATCH}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json \
  "${EOI_API_BASE_URL}/streams/${EOI_STREAMID}/analytics"

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 StreamAnalyticsResponse
403 Delegation, current authority, or a scene reference is not allowed. — Empty body
409 Stream revision changed. — Empty body
503 A single-server durable analytics authority is required. — Empty body
422 Validation Error application/json HTTPValidationError

Operation identifier replaceStreamAnalytics. Browse Stream analytics.

Image preview