Encryption Interface

Create new encryption wallet

POST/api/v6.1.5.2/wallet

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'props' : { prop *: value } 'password' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates one or more of the following events: Reencrypt_Secrets `'new_encryption_key_sequence' ?: 'force' ?:` Wallet_Create `'props' : { prop *: value }`

POST/api/v6.1.5.2/wallet/change

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'props' ?: { prop *: value \| } 'password' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: No wallet configured
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates the following event: Wallet_Change `'props_after' ?: { prop : value \| } 'props_before' ?: { prop : value } 'password_changed' ?:`

POST/api/v6.1.5.2/wallet/disable

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'force' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: No wallet configured or already disabled
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates one or more of the following events: Reencrypt_Secrets `'new_encryption_key_sequence' ?: 'force' ?:` Wallet_Disable `'force' ?:`

POST/api/v6.1.5.2/wallet/encode_managed_password

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'password_token' :`
Response headers	None
Response body (JSON)	Prototype: `'encoded_password_token' : 'verification_error' ?:`
Status codes	✅ 200 OK ❌ 400 Bad Request: Invalid 'password_token' input
Required permissions	No special permission required
Events	Creates no events.

POST/api/v6.1.5.2/wallet/key_history_delete

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'before_key_sequence' ?: 'before_rotation_tstamp' ?:`
Response headers	None
Response body (JSON)	Prototype: `'key_history_deleted' :`
Status codes	✅ 200 OK ❌ 400 Bad Request: No wallet configured
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates the following event: Wallet_Key_History_Delete `'before_key_sequence' ?: 'before_rotation_tstamp' ?: 'key_history_deleted' :`

POST/api/v6.1.5.2/wallet/key_rotate

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: No wallet configured
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates one or more of the following events: Reencrypt_Secrets `'new_encryption_key_sequence' ?: 'force' ?:` Wallet_Key_Rotation `'new_encryption_key_sequence' ?:`

POST/api/v6.1.5.2/wallet/migrate

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'props' : { prop *: value } 'password' ?: 'rotate_encryption_key' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: No wallet configured
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates one or more of the following events: Reencrypt_Secrets `'new_encryption_key_sequence' ?: 'force' ?:` Wallet_Migrate `'props_after' : { prop : value \| } 'props_before' ?: { prop : value } 'new_encryption_key_sequence' ?:`

GET/api/v6.1.5.2/wallet/props

Query parameters	Prototype: `'fetch' ?: ( prop+ )`
Request headers	Prototype: `X-Hvr-Classified-Access :`
Request body	None
Response headers	Prototype: `X-Hvr-Classified-Transport-Key : X-Hvr-Redacted-Storage :`
Response body (JSON)	Prototype: `prop *: value`
Status codes	✅ 200 OK ❌ 400 Bad Request: No wallet configured
Required permissions	sysadmin access Available while Setup Mode is active.

POST/api/v6.1.5.2/wallet/reencrypt_continue

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'force' ?:`
Response headers	None
Response body	None
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates the following event: Reencrypt_Secrets `'new_encryption_key_sequence' ?: 'force' ?:`