API ReferenceSecret

Search

Returns metadata about secrets that match a given query.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
queryobjectRequired
sortobjectRequired
pageSizeintegerOptional

Defaults to 100. Will throw if larger than 1000.

tokenstringOptional

Tokens are used with paginated requests to get the next “page” of results from an API, and typically are used as both part of the request and response schema of an endpoint to allow users to stream pages of results.

archivedStatusesset of enumsOptional

Default search status is NOT_ARCHIVED if none are provided. Allows for including archived secrets in search.

Allowed values:

Response

This endpoint returns an object.
resultslist of objects
nextPageTokenstringOptional

Tokens are used with paginated requests to get the next “page” of results from an API, and typically are used as both part of the request and response schema of an endpoint to allow users to stream pages of results.