Skip to main content

Create backup

Creates a backup file for entities in the system.

Any entities bound to local hardware keys (that is, keys of storageType: SECURE_ELEMENT) are unexportable. This means, for example, that keys stored by iOS Secure Enclave or Android Keystore, DIDs created by such keys, and credentials signed by such keys, cannot be exported and will be permanently lost if a backup in finalized via the finalize import function. To give warning, this function returns unexportable entities.

Unexportable entities can also be seen without creating a backup file via backup info.

To stage the backup file as a temporary preview, use unpack backup.

Function​

createBackup(password: string, outputPath: string): Promise<BackupCreate>

Parameters​

  • password - Set a password for encryption of the backup file. This password is required when unpacking this backup file. Can be an empty string.

  • outputPath - Specify the full file path (including file name) of the resulting backup file. If a backup file already exists at this location it will be overwritten with the new file.

Return value​

export interface BackupCreate {
  historyId: HistoryListItem["id"];
  file: string;
  unexportable: UnexportableEntities;
}

  • file - Path of the created backup file.

  • historyId - The identifier for the history entry related to the backup file creation. The history entry can be retrieved using the "Get history entry" endpoint.

  • unexportable - Set of credentials which cannot be exported for backup. If the import is finalized these entities will be permanently lost.