Skip to navigation
API referenceSecretsVersions

Read one credential version

Metadata, state and reference counts for one version.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Path parameters

secret_idstringRequired1-128 characters
Resource identity within the authenticated workspace.
versionintegerRequired>=1
Secret version number.

Response headers

X-Request-IdstringOptional
Safe server request correlation ID.
RateLimit-LimitintegerOptional
Requests allowed in the current window for the tightest applicable limit.
RateLimit-RemainingintegerOptional
Requests left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window resets.

Response

Read one credential version.
secret_idstring<=128 characters
Opaque sec identifier. Do not parse its contents.
versioninteger>=1
statestring

Open response vocabulary. Preserve unknown values; never assume they mean success.

created_atdatetime
revoked_atdatetime or null
revoke_reasonstring or null

Reason given to revokeSecretVersion. Open response vocabulary. Preserve unknown values; never assume they mean success.

usageobject

Reference counts at response time. Use GET /secrets/{secret_id}/references for the exact consumers.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error