Skip to navigation

Search secrets

Searches secret names and metadata in the workspace. Never returns values. Billed as one list call. Requires scope: secret-manager.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl "https://api.ibee.ai/v1/secret-manager/catalog?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

querystringOptional<=200 characters
Text to search for.
secret_typestringOptionalformat: "^[a-z_]+$"<=64 characters
Return only this secret type.
managed_bystringOptionalformat: "^[A-Za-z0-9_.-]+$"<=100 characters
Return only secrets managed by this tool.
cursorstringOptionalformat: "uuid"
Cursor from the previous page.
limitintegerOptional1-100Defaults to 50

Page size (1-100). Default 50.

Response

Success.

Errors

401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error