Skip to navigation

Check a namespace name

Says whether a namespace name is free before you enable Secret Manager. 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).
# NAME: The namespace to check
curl "https://api.ibee.ai/v1/secret-manager/namespaces/$NAME/availability?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.

Path parameters

namestringRequiredformat: "^[A-Za-z0-9-]{1,64}$"
The namespace to check.

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.

Response

Success.
namespacestring
availableboolean
reasonenum or nullOptional
Allowed values:

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