Skip to navigation

Change registry visibility

Makes a registry private or public. Public requires acknowledge_public_egress_charges: true, because anonymous pull bandwidth is billed to the workspace. Returns 202 while the change is applied. Requires scope: container-registry.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# REGISTRY_ID: Registry ID
curl -X PATCH "https://api.ibee.ai/v1/container-registry/registries/$REGISTRY_ID/visibility?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"visibility": "PRIVATE"}'

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_idstringRequiredformat: "uuid"
Registry ID.

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.
visibilityenumRequired

PRIVATE registries need a registry access token to pull. PUBLIC registries allow anonymous pulls, whose outbound bandwidth is billed to the workspace. Pushing always needs a token with push permission.

Allowed values:
acknowledge_public_egress_chargesbooleanOptionalDefaults to false

Required to be true when visibility is PUBLIC.

Response

Visibility change accepted.
registry_idstringformat: "uuid"
Unique ID of the registry.
registry_namestring

Registry name. Images live at registry.ibee.ai/<registry_name>/<repository>:<tag>.

registry_kindenum

Always CUSTOMER for registries created through the API.

Allowed values:
organization_idstring
ID of the owning organization.
workspace_idstring
ID of the owning workspace.
visibilityenum

PRIVATE registries need a registry access token to pull. PUBLIC registries allow anonymous pulls, whose outbound bandwidth is billed to the workspace. Pushing always needs a token with push permission.

Allowed values:
securityobject
Security settings of a registry.
desired_stateenum

State requested by the caller.

  • ACTIVE
  • DELETED
Allowed values:
observed_stateenum

State the registry service has actually reached.

  • PROVISIONING: being created.
  • UPDATING: a change is being applied.
  • DELETING: being removed.
  • ACTIVE: ready.
  • ERROR: the last change failed.
  • DELETED: removed.
generationinteger
Incremented by every accepted change.
observed_generationinteger

The last generation applied; equal to generation when settled.

created_atdatetime

When the registry was created (ISO 8601).

updated_atdatetime

When the registry was last changed (ISO 8601).

deleted_atdatetime or null

When deletion was requested (ISO 8601); null while the registry exists.

Errors

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