Skip to navigation
API ReferenceSecrets

Get a secret

View as Markdown

Read one Secret: its metadata and which fields are set. Secret fields are write-only; use POST /v1/secrets/{secret}/reveal to read values.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

secretstringRequired
Unique secret identifier generated by BCTRL.

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
hasNotesboolean
hasPasswordboolean
hasTotpboolean
hasValueboolean
idstring
Unique secret identifier generated by BCTRL.
labelstring or null
lastUsedAtdatetime or null
RFC 3339 timestamp with a UTC offset.
object"secret"
originslist of strings

Origins a login may be filled into: https://host[:port], or https://*.host for any subdomain.

pathstring1-512 characters

Secret path, for example prod/github/bot. May contain /.

subaccountIdstring or null1-64 characters

The owning subaccount, or null for an organization-wide secret.

typeenum

login: username, password and TOTP seed for a site. value: one opaque value.

Allowed values:
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.
usernamestring or null

Not secret; readable.

versioninteger

Current version; the ETag of the secret.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error