Skip to content

Backup & Restore

Compatible with: multiScan100 multiScan200 picoScan100

A configuration file contains the complete device configuration. Use it to roll back to a known-good state, replace a device, or copy a validated configuration to identical sensors. Encryption with a passphrase is optional.

In the Web GUI

Open the Device menu at the top right and select Download configuration file. The same menu imports a file.

Device menu with Download configuration file selected

Access the configuration backup from the Device menu.

REST Endpoints

REST Endpoints: action, method and path, device families, and authentication.

Action Method and path Device families Authentication
Create a session token POST /api/CreateSessionToken multiScan200, picoScan100 Challenge-response, Service
Create the backup file POST /api/CreateParameterBackup multiScan100, multiScan200, picoScan100 Challenge-response, Service
Check the create result GET /api/CreateParameterBackupResult multiScan200, picoScan100 None
Download the file GET /api/parameterbackup multiScan100, multiScan200, picoScan100 X-Session-Token header where required by firmware
Upload a file PUT /api/parameterbackup multiScan100, multiScan200, picoScan100 X-Session-Token header where required by firmware
Apply the uploaded file POST /api/RestoreParameterBackup multiScan100, multiScan200, picoScan100 Challenge-response, Service
Check the restore result GET /api/RestoreParameterBackupResult multiScan200, picoScan100 None

The session token protects binary transfers where the firmware exposes that mechanism. CreateParameterBackup and RestoreParameterBackup accept an optional Passphrase (up to 256 characters). It is independent of the login password. A file created with a passphrase can only be restored with the same passphrase.

{ "header": { "...": "challenge-response fields" }, "data": { "Passphrase": "your-passphrase" } }

Download a Configuration

  1. On multiScan200 and picoScan100, POST /api/CreateSessionToken and store data.token. On multiScan100, follow the file-transfer authentication described by the matching OpenAPI file.
  2. POST /api/CreateParameterBackup, optionally with a passphrase. Use a new challenge for this request.
  3. On multiScan200 and picoScan100, poll GET /api/CreateParameterBackupResult until data.Status is 1 (Finished), and check that data.Result is true. On multiScan100, wait for the create request to finish before downloading.

  4. Download the file:

    GET /api/parameterbackup HTTP/1.1
Host: 192.168.0.1
X-Session-Token: dKVwNYUkHsHS...

    The response is HTTP 200 with the binary file (about 86 KB). Without the token header, the device returns HTTP 403.

Restore a Configuration

  1. On multiScan200 and picoScan100, POST /api/CreateSessionToken and store data.token. On multiScan100, follow the file-transfer authentication described by the matching OpenAPI file.

  2. Upload the file:

    PUT /api/parameterbackup HTTP/1.1
Host: 192.168.0.1
X-Session-Token: dKVwNYUkHsHS...
Content-Type: application/octet-stream

<binary backup content>

  3. POST /api/RestoreParameterBackup with a fresh challenge and the same passphrase that was used to create the file.

  4. On multiScan200 and picoScan100, poll GET /api/RestoreParameterBackupResult until the restore is finished, and check the result.
  5. Persist the result with POST /api/WriteEeprom, then confirm the checksums and key parameters.

Error Handling

Error Handling: symptom, cause, and fix.

Symptom Cause Fix
HTTP 403 on GET/PUT parameterbackup Missing or expired session token Create a new token; send the X-Session-Token header
Download returns an empty or partial file File read before creation finished Poll CreateParameterBackupResult before downloading
Restore rejected Wrong passphrase, or a file from a different device type Use the same passphrase; restore only onto a matching device type
header.status 4 or 10 on Create* or Restore* Wrong password, user level not enabled, or the challenge was invalidated Fetch a new challenge per request; use Service

Roll Out a Configuration to Many Sensors

Configure and validate one "golden" device, download its configuration file, and restore it on every identical sensor. This also transfers field evaluation groups, which you can then modify over REST. Use the LFTchecksum to confirm that a restore changed only what you expected. Firmware Update uses the same session-token pattern.

How to create a device configuration offline and import it.

How to import and export configuration with SOPAS ET.