Skip to navigation
API ReferenceSecrets

List secrets

View as Markdown

List Secrets by path. prefix narrows to paths starting with it; delimiter=/ groups deeper paths into folders, like S3. Secret values are never listed.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

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.

Query parameters

prefixstringOptional<=512 characters
Only paths starting with this prefix.
delimiter"/"Optional

Group paths below the next / after the prefix into folders.

typeenumOptional

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

Allowed values:
cursorstringOptional
orderenumOptional
Order by createdAt and ID. Defaults to desc.
Allowed values:
limitintegerOptional<=200Defaults to 50

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
datalist of objects
folderslist of strings

With delimiter: common prefixes, each ending in /. They count toward limit.

hasMorebooleanDefaults to false
nextCursorstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error