Skip to main content
GET
Get a wrapped secret version
See customer-protected secrets for SDK examples. The SDKs’ secrets.unwrap() calls this and unwraps the result for you.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Secret ID.

version
required

Version number, or latest.

Required range: 1 <= x <= 2147483647

Response

Success

A customer-protected version as stored. Unwrap envelope with your key to get the inner envelope each use passes as unwrapped.

version
integer
required
Required range: x >= 1
kid
string
required

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

retiresAt
string<date-time> | null
required

When that platform key is retired, or null.

outerKid
string
required

ID of your key that wrapped the version.

innerDigest
string
required

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

envelope
string
required

The wrapped envelope, which only your key can open.