Skip to navigation

Destroy secret versions

Destroys versions permanently. This cannot be undone. 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 POST "https://api.ibee.ai/v1/secret-manager/secret-versions/$SECRET_PATH/destroy?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"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.
versionslist of integersRequired

Response

Success.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found 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