Skip to content

Save & Recall Settings

Save and restore complete camera configurations using .DAT settings files. Not all cameras support settings download/upload — see Compatibility for the list.

See the auto-generated API reference for full request/response schemas.

Before you start: the camera has to allow it

Section titled “Before you start: the camera has to allow it”

The SDK only permits these operations while the camera reports that it will accept them. Read the three gate properties with GET /properties/all first — a 400 from either endpoint below usually means the camera is refusing, not that the request was malformed.

Property Required value Meaning
camera-setting-save-enable 1 (Enable) Camera will allow a download
camera-setting-read-enable 1 (Enable) Camera will accept an upload
camera-setting-save-read-state 0 (Idle) No transfer already in progress

POST /api/cameras/{cameraId}/settings/download — download the camera’s current settings to a file on the host PC. Body: optional filename (e.g. CUMSET.DAT).

Terminal window
curl -X POST http://localhost:8080/api/cameras/D10F60149B0C/settings/download \
-H "Content-Type: application/json" \
-d '{"filename": "CUMSET.DAT"}'

A typical settings file is around 180 KB. Completion also emits a downloadComplete SSE event.

Gated on camera-setting-save-enable being 1 with camera-setting-save-read-state at 0.


POST /api/cameras/{cameraId}/settings/upload — restore a previously saved settings file. Body: filename (required).

filename is resolved inside the server’s camera_settings/ directory — use List Settings Files to see what is available.

Terminal window
curl -X POST http://localhost:8080/api/cameras/D10F60149B0C/settings/upload \
-H "Content-Type: application/json" \
-d '{"filename": "CUMSET.DAT"}'

The result arrives as an SSE settingsResult event:

{"operation": "read", "success": true}

Gated the same way as download, but on camera-setting-read-enable being 1 (with camera-setting-save-read-state at 0). Recording media must be present — slot 1 on two-slot bodies.


GET /api/cameras/{cameraId}/settings/files — list the settings files available in the server’s camera_settings/ directory.

Terminal window
curl http://localhost:8080/api/cameras/D10F60149B0C/settings/files