HITL

Upload HITL keypair

Upload the client-generated RSA keypair for a HITL config. ?force=true acknowledges the key-rotation cascade, which invalidates envelopes wrapped to the previous key. A ROTATION (a new kid on an active config) from a JWT dashboard session requires a live hitl_key_rotate 2FA step-up grant (403 2fa_required — start one via POST /me/2fa/start with action_type: hitl_key_rotate); an API-key caller is not step-up gated. Every successful rotation, from either path, emails the account owner at their primary email address (when one is on file). A same-kid update (re-wrapping the private key) and the first upload on a config without a keypair need no grant and send no email.

put/api/v1/hitl/{id}/keys

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/hitl/{id}/keys
  • Auth: one of:
    • HTTP bearer
    • API key in cookie auth_token

Path parameters

idstring required

HITL config id

Example:507f1f77bcf86cd799439011

Query parameters

force'true' | 'false'

Acknowledge the key-rotation cascade

Request body

public_keystring required
encrypted_private_keystring required
kdf_saltstring required
wrapped_dekstring
dek_ivstring
dek_tagstring
backup_wrapped_dekstring
backup_dek_ivstring
backup_dek_tagstring

Response

Keypair stored

object required

Changes

No recorded changes to this operation across all 1 revision of this API.