Skip to content
LogoLogo

Encryption

Operations related to encryption and security

Encrypt Project Shares

POST/project/encrypt

Encrypts all project shares using the provided encryption part

Request Body

application/json
encryption_partRequired
string

Encryption part for encrypting shares

Exampleencryption_part_value

Responses

200Shares encrypted successfully

Register Encryption Session

POST/project/encryption-session

Creates a one-time encryption session for secure operations

Request Body

application/json
encryption_partRequired
string

Encryption part for the session

Exampleencryption_part_value
user_id
string

User the session is opened for. Required when 2FA is enabled.

Exampleusr_1
otp_code
string

One-time password for the user. Required when 2FA is enabled.

Example123456

Responses

Register Encryption Key

POST/project/encryption-key

Generates and registers a new encryption key for the project

Responses

Prepare Encryption Key Rotation

POST/project/rotate-encryption-key/prepare

Verifies the current encryption part and returns the project's half of a new key. Nothing changes until commit. Preparing again replaces the pending key. A pending key expires after 15 minutes.

Request Body

application/json
encryption_partRequired
string

The project's current encryption part

Responses

Commit Encryption Key Rotation

POST/project/rotate-encryption-key/commit

Re-encrypts every project-entropy share under the prepared key and makes it current. Repeating the commit returns status: already_committed, so a lost response is safe to retry.

Request Body

application/json
encryption_partRequired
string

The project's current encryption part

new_encryption_partRequired
string

The encryption part returned by prepare

Responses

Presented By