Skip to content

Get edge desired configuration

GET /api/v1/edge-protocol/devices/{device_id}/configuration

Scoped device bearer only. Canonical signed configuration is unchanged when camera revisions/settings are unchanged. Earlier revisions remain available to queued media.

Authentication options declared in the contract include device-scoped appliance credential.

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

Name Location Required Type Description and constraints
device_id path Yes string (uuid)

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

Terminal window
curl --fail-with-body --silent --show-error \
--header "Authorization: Bearer ${EOI_EDGE_TOKEN}" \
"${EOI_API_BASE_URL}/edge-protocol/devices/${EOI_DEVICE_ID}/configuration"

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 SignedEdgeConfiguration
422 Validation Error application/json HTTPValidationError

Operation identifier getEdgeDesiredConfiguration. Browse Device protocol.

Image preview