Skip to navigation
API ReferenceContainer Registry

Upgrade registry storage plan

Moves an active registry to a larger storage plan. Only larger quotas are accepted and only one change can be pending (409 otherwise). The registry service asks Billing first and refuses with 403 billing_resource_not_eligible when the plan is not allowed. Send an Idempotency-Key header: a retry with the same key and plan returns the original operation (202 while pending, 200 once applied); the same key with a different plan returns 409. 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 POST "https://api.ibee.ai/v1/container-registry/registries/$REGISTRY_ID/upgrade?workspace_id=$WORKSPACE_ID" \
  -H "Authorization: Bearer $IBEE_API_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"billing_catalog": {"sku_code": "<sku_code>"}}'

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.

Headers

Idempotency-KeystringRequiredformat: "^[A-Za-z0-9._:-]+$"1-128 characters

Unique key for this upgrade. The registry service reads this header (not X-Idempotency-Key); a retry with the same key and plan returns the original operation.

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.
billing_catalogobjectRequired
The storage plan to bill the registry against, identified by SKU.

Response

Replay of an upgrade that has already been applied.
operation_idstringformat: "uuid"
Unique ID of the operation.
registry_idstringformat: "uuid"
ID of the registry.
kindenum
  • CREATE: the plan chosen at registry creation.
  • UPGRADE: a move to a larger plan.
Allowed values:
statusenum
  • PENDING: not applied yet.
  • APPLIED: in effect.
  • CANCELLED: withdrawn before it was applied.
Allowed values:
sku_codestring
Storage plan SKU code.
quota_bytesinteger

Storage quota of the plan in bytes (decimal GB).

quota_gbdouble

Decimal GB (1 GB = 1,000,000,000 bytes).

created_atdatetime

When the operation was requested (ISO 8601).

effective_atdatetime or null

When the operation took or will take effect (ISO 8601); null when not yet scheduled.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
503
Service Unavailable Error