HYhyperbrowser

Get a wrapped secret version

Changed on

Returns a customer-protected version's wrapped envelope, for you to unwrap with your own key. Pass the result to a use as {name, version, unwrapped}. See Customer-protected secrets. Secrets are enabled for teams on request; please contact support to enable them (otherwise 403 SECRETS_FEATURE_DISABLED). Restricted API keys need the secrets.use scope. When you're signed in rather than using an API key, you must be a team owner or admin (otherwise 403 SECRETS_ADMIN_REQUIRED).

get/api/secrets/{id}/versions/{version}/wrapped

Request

Path parameters

idstring uuid required

Secret ID.

integer required
OR
'latest' required

Version number, or latest.

Response

Success

versioninteger required
kidstring required

ID of the platform public key the inner envelope is encrypted to.

retiresAtstring date-time nullable required

When that platform key is retired, or null.

outerKidstring required

ID of your key that wrapped the version.

innerDigeststring required

Unpadded base64url SHA-256 of the inner envelope. Check the envelope you unwrap against it.

envelopestring required

The wrapped envelope, which only your key can open.

Changes