Device Configurations Archiving

Overview

The Sign & Encrypt service now supports archiving device configurations. This feature allows you to organize your device configurations by archiving inactive ones, keeping your workspace clean while preserving all historical data. Archived configurations remain fully accessible and can be restored to active status at any time.

Key Capabilities

• Archive and restore — Mark device configurations as archived or restore them back to active status with a single API call.
• Filter by status — Retrieve device configurations filtered by their archive state: active only, archived only, or all.
• Non-destructive — Archiving does not delete any data. All configuration details, associated tasks, and history are preserved.
• Audit trail — Every archive and restore action is recorded in the audit log for full traceability.

API Changes

New Endpoint: Update Archive Status

PATCH /api/v1/deviceConfig/{configId}

Sets the archive status of a device configuration.

Request body:

{
  "archived": true
}

Response: Returns the updated device configuration with the new archive status.

Permission required: EDIT on the device configuration.

Updated Endpoint: List Device Configurations

GET /api/v1/deviceConfig

A new optional query parameter filter has been added to control which configurations are returned.

Examples:

Note: The default filter is ACTIVE, so existing integrations that do not specify a filter will continue to see only active configurations. No changes are required for current API consumers.

 

Response Model Changes

The Device configuration object now includes a new field:

Backward Compatibility

This feature is fully backward compatible:

• The default filter value (ACTIVE) ensures existing API consumers see the same results as before.
• All existing device configurations default to archived: false (active).
• No migration steps are required on the consumer side.