Skip to navigation

Create or update secret metadata

Creates the secret’s entry (name, type and metadata) or updates it. It never takes a value: write values through the Vault API at the workspace endpoint with an app credential. Requires scope: secret-manager.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# SECRET_PATH: The secret's path, such as `apps/billing/db`, sent with plain `/` between segments
curl -X PUT "https://api.ibee.ai/v1/secret-manager/secret-metadata/$SECRET_PATH?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"custom_metadata": {}, "max_versions": 1}'

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.

Path parameters

secret_pathstringRequired

The secret’s path, such as apps/billing/db, sent with plain / between segments. An encoded %2F is answered with a 307 redirect to the plain-slash path. Segments use letters, digits, _, . and -.

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.

Request

This endpoint expects an object.
custom_metadatamap from strings to strings or nullOptional
max_versionsinteger or nullOptional0-1000
cas_requiredboolean or nullOptional
delete_version_afterstring or nullOptionalformat: "^(0|(?:\d+[hms])+)$"<=64 characters

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