Skip to navigation
API ReferenceContainer Registry

Check registry name availability

Checks whether a registry name is free across IBEE. Names are global and never reassigned; unavailable names come with suggestions. Requires scope: container-registry.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# REGISTRY_NAME: Registry name to check
curl "https://api.ibee.ai/v1/container-registry/registry-names/$REGISTRY_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

registry_namestringRequiredformat: "^[a-z][a-z0-9-]{1,46}[a-z0-9]$"3-48 characters
Registry name 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

Availability returned.
registry_namestring
Name that was checked.
availableboolean
True when the name is free.
suggestionslist of strings
Free names close to the requested one, when it is taken.

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
503
Service Unavailable Error