Skip to main content
GET
Get a secret

Authorizations

Authorization
string
header
required

Bearer token for the authenticated caller.

Headers

akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def4"

Path Parameters

vault
string
required

A vault id chosen by its creator, unique in the Workspace. default is the Workspace vault.

Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Example:

"default"

secret
string
required

A secret id, unique in its vault

Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Example:

"db-password"

Response

Secret

name
string
required

Resource name vaults/{vault}/secrets/{secret}.

Example:

"vaults/default/secrets/db-password"

vault_id
string
required

A vault id chosen by its creator, unique in the Workspace. default is the Workspace vault.

Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Example:

"default"

secret_id
string
required

A secret id, unique in its vault

Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Example:

"db-password"

labels
object
required
latest_version
integer | null
required
version_count
integer
required
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
updated_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
etag
string
required

Pass as If-Match on writes. OUTPUT_ONLY.

Maximum string length: 64