---
url: https://ibee.ai/docs/api-reference/container-registry/upgrade-container-registry-package
last_updated: 2026-10-25
---

> For clean Markdown of any page, append .md to the page URL. For a complete documentation index, see https://ibee.ai/docs/llms.txt (full text of every page: https://ibee.ai/docs/llms-full.txt). For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://ibee.ai/docs/_mcp/server.

# Upgrade registry storage plan

POST https://api.ibee.ai/v1/container-registry/registries/{registry_id}/upgrade
Content-Type: application/json

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>"}}'
```

Reference: https://ibee.ai/docs/api-reference/container-registry/upgrade-container-registry-package

## Authentication

- `Authorization` header (bearer token, required) — 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.

## Servers

- `https://api.ibee.ai/v1` (Production, default)
- `https://api.ibee.co.in/v1` (Development)

## Request

### Path parameters

- `registry_id` (string, required) — Registry ID.

### Query parameters

- `workspace_id` (string, required) — The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

### Headers

- `Idempotency-Key` (string, required) — 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.

### Body (application/json)

This endpoint expects an UpgradeContainerRegistryPackageRequest.

- `billing_catalog` (ContainerRegistryBillingCatalog, required) — The storage plan to bill the registry against, identified by SKU.

## Response

### 200

Replay of an upgrade that has already been applied.

- `operation_id` (string, required) — Unique ID of the operation.
- `registry_id` (string, required) — ID of the registry.
- `kind` (enum, required) — - `CREATE`: the plan chosen at registry creation. - `UPGRADE`: a move to a larger plan.
  - Allowed values: `CREATE`, `UPGRADE`
- `status` (enum, required) — - `PENDING`: not applied yet. - `APPLIED`: in effect. - `CANCELLED`: withdrawn before it was applied.
  - Allowed values: `PENDING`, `APPLIED`, `CANCELLED`
- `sku_code` (string, required) — Storage plan SKU code.
- `quota_bytes` (integer, required) — Storage quota of the plan in bytes (decimal GB).
- `quota_gb` (double, required) — Decimal GB (1 GB = 1,000,000,000 bytes).
- `created_at` (datetime, required) — When the operation was requested (ISO 8601).
- `effective_at` (datetime, required, nullable) — When the operation took or will take effect (ISO 8601); null when not yet scheduled.

### 202

Upgrade accepted and pending.

- `operation_id` (string, required) — Unique ID of the operation.
- `registry_id` (string, required) — ID of the registry.
- `kind` (enum, required) — - `CREATE`: the plan chosen at registry creation. - `UPGRADE`: a move to a larger plan.
  - Allowed values: `CREATE`, `UPGRADE`
- `status` (enum, required) — - `PENDING`: not applied yet. - `APPLIED`: in effect. - `CANCELLED`: withdrawn before it was applied.
  - Allowed values: `PENDING`, `APPLIED`, `CANCELLED`
- `sku_code` (string, required) — Storage plan SKU code.
- `quota_bytes` (integer, required) — Storage quota of the plan in bytes (decimal GB).
- `quota_gb` (double, required) — Decimal GB (1 GB = 1,000,000,000 bytes).
- `created_at` (datetime, required) — When the operation was requested (ISO 8601).
- `effective_at` (datetime, required, nullable) — When the operation took or will take effect (ISO 8601); null when not yet scheduled.

## Errors

### 401 Unauthorized Error

The API token is missing, malformed or unknown (`invalid_api_key`).

- `error` (string, optional, nullable) — Machine-readable code from the gateway's authorization step, for example `invalid_api_key`, `insufficient_scope`, `organization_restricted`, `organization_suspended`, `verification_required` or `billing_denied`. The response descriptions list the codes for each status.
- `required_scope` (string, optional, nullable) — The scope the token lacks, with `insufficient_scope`.
- `billing_reason` (string, optional, nullable) — Billing's reason with `billing_denied`, passed through unchanged: for example `insufficient_balance`, `credit_limit_exceeded`, `initial_topup_required`, `resource_limit_reached` or `resource_usage_unavailable`.
- `billing_sku_code` (string, optional, nullable) — The SKU the billing admission checked, when there was one.
- `billing_evaluated_at` (string, optional, nullable) — When Billing made the decision, as Billing returned it.
- `admission_context_id` (string, optional, nullable) — Billing admission context for this request, derived from the token, workspace, route and `X-Idempotency-Key`, so a retry with the same key gets the same id.
- `detail` (ErrorDetail, optional) — Error detail from the product service.

### 403 Forbidden Error

The token may not make this call. Gateway codes: `insufficient_scope` (with `required_scope`), `key_revoked`, `key_disabled`, `key_inactive`, `key_expired`, `unknown_route`, `workspace_not_allowed`, `principal_inactive`, `principal_not_member` and `principal_permission_denied`. On writes, also `organization_restricted` (an admin restricted the organization) and `verification_required` (the token's user has not completed identity verification). A product service may also refuse with `detail`.

- `error` (string, optional, nullable) — Machine-readable code from the gateway's authorization step, for example `invalid_api_key`, `insufficient_scope`, `organization_restricted`, `organization_suspended`, `verification_required` or `billing_denied`. The response descriptions list the codes for each status.
- `required_scope` (string, optional, nullable) — The scope the token lacks, with `insufficient_scope`.
- `billing_reason` (string, optional, nullable) — Billing's reason with `billing_denied`, passed through unchanged: for example `insufficient_balance`, `credit_limit_exceeded`, `initial_topup_required`, `resource_limit_reached` or `resource_usage_unavailable`.
- `billing_sku_code` (string, optional, nullable) — The SKU the billing admission checked, when there was one.
- `billing_evaluated_at` (string, optional, nullable) — When Billing made the decision, as Billing returned it.
- `admission_context_id` (string, optional, nullable) — Billing admission context for this request, derived from the token, workspace, route and `X-Idempotency-Key`, so a retry with the same key gets the same id.
- `detail` (ErrorDetail, optional) — Error detail from the product service.

### 404 Not Found Error

The requested resource was not found.

- `error` (string, optional, nullable) — Machine-readable code from the gateway's authorization step, for example `invalid_api_key`, `insufficient_scope`, `organization_restricted`, `organization_suspended`, `verification_required` or `billing_denied`. The response descriptions list the codes for each status.
- `required_scope` (string, optional, nullable) — The scope the token lacks, with `insufficient_scope`.
- `billing_reason` (string, optional, nullable) — Billing's reason with `billing_denied`, passed through unchanged: for example `insufficient_balance`, `credit_limit_exceeded`, `initial_topup_required`, `resource_limit_reached` or `resource_usage_unavailable`.
- `billing_sku_code` (string, optional, nullable) — The SKU the billing admission checked, when there was one.
- `billing_evaluated_at` (string, optional, nullable) — When Billing made the decision, as Billing returned it.
- `admission_context_id` (string, optional, nullable) — Billing admission context for this request, derived from the token, workspace, route and `X-Idempotency-Key`, so a retry with the same key gets the same id.
- `detail` (ErrorDetail, optional) — Error detail from the product service.

### 409 Conflict Error

The request conflicts with the current resource state.

- `error` (string, optional, nullable) — Machine-readable code from the gateway's authorization step, for example `invalid_api_key`, `insufficient_scope`, `organization_restricted`, `organization_suspended`, `verification_required` or `billing_denied`. The response descriptions list the codes for each status.
- `required_scope` (string, optional, nullable) — The scope the token lacks, with `insufficient_scope`.
- `billing_reason` (string, optional, nullable) — Billing's reason with `billing_denied`, passed through unchanged: for example `insufficient_balance`, `credit_limit_exceeded`, `initial_topup_required`, `resource_limit_reached` or `resource_usage_unavailable`.
- `billing_sku_code` (string, optional, nullable) — The SKU the billing admission checked, when there was one.
- `billing_evaluated_at` (string, optional, nullable) — When Billing made the decision, as Billing returned it.
- `admission_context_id` (string, optional, nullable) — Billing admission context for this request, derived from the token, workspace, route and `X-Idempotency-Key`, so a retry with the same key gets the same id.
- `detail` (ErrorDetail, optional) — Error detail from the product service.

### 422 Unprocessable Entity Error

The registry service rejected a parameter or the body (`detail` lists the invalid fields), or the selected storage plan is not sold here (`detail.code`, for example `billing_sku_unavailable` or `billing_selection_not_found`).

- `error` (string, optional, nullable) — Machine-readable code from the gateway's authorization step, for example `invalid_api_key`, `insufficient_scope`, `organization_restricted`, `organization_suspended`, `verification_required` or `billing_denied`. The response descriptions list the codes for each status.
- `required_scope` (string, optional, nullable) — The scope the token lacks, with `insufficient_scope`.
- `billing_reason` (string, optional, nullable) — Billing's reason with `billing_denied`, passed through unchanged: for example `insufficient_balance`, `credit_limit_exceeded`, `initial_topup_required`, `resource_limit_reached` or `resource_usage_unavailable`.
- `billing_sku_code` (string, optional, nullable) — The SKU the billing admission checked, when there was one.
- `billing_evaluated_at` (string, optional, nullable) — When Billing made the decision, as Billing returned it.
- `admission_context_id` (string, optional, nullable) — Billing admission context for this request, derived from the token, workspace, route and `X-Idempotency-Key`, so a retry with the same key gets the same id.
- `detail` (ErrorDetail, optional) — Error detail from the product service.

### 503 Service Unavailable Error

A service the request depends on did not answer. Gateway codes: `workspace_verification_unavailable`, `principal_verification_unavailable` and `principal_authorization_unavailable`; on billable creates also `billing_admission_timeout`, `billing_admission_unavailable`, `billing_admission_disabled`, `billing_admission_not_configured` and the catalog codes `compute_catalog_unavailable`, `compute_catalog_not_configured`, `product_catalog_timeout`, `product_catalog_unavailable`, `product_catalog_not_configured` and `unsupported_product_quote`. Otherwise the product service's `detail`.

- `error` (string, optional, nullable) — Machine-readable code from the gateway's authorization step, for example `invalid_api_key`, `insufficient_scope`, `organization_restricted`, `organization_suspended`, `verification_required` or `billing_denied`. The response descriptions list the codes for each status.
- `required_scope` (string, optional, nullable) — The scope the token lacks, with `insufficient_scope`.
- `billing_reason` (string, optional, nullable) — Billing's reason with `billing_denied`, passed through unchanged: for example `insufficient_balance`, `credit_limit_exceeded`, `initial_topup_required`, `resource_limit_reached` or `resource_usage_unavailable`.
- `billing_sku_code` (string, optional, nullable) — The SKU the billing admission checked, when there was one.
- `billing_evaluated_at` (string, optional, nullable) — When Billing made the decision, as Billing returned it.
- `admission_context_id` (string, optional, nullable) — Billing admission context for this request, derived from the token, workspace, route and `X-Idempotency-Key`, so a retry with the same key gets the same id.
- `detail` (ErrorDetail, optional) — Error detail from the product service.

## Types

### ContainerRegistryBillingCatalog

The storage plan to bill the registry against, identified by SKU.

- `sku_code` (string, required) — Storage plan SKU, for example `REGISTRY-STORAGE-250GB`. The service trims and upper-cases it, then requires `^[A-Z0-9][A-Z0-9_.-]*$`. Capacity and price come from Billing.

### ErrorDetail

Error detail from the product service.

- string
- map from string to any
- list of any

## Examples

**Request**

```json
{
  "billing_catalog": {
    "sku_code": "<sku_code>"
  }
}
```

**Response**

```json
{
  "operation_id": "4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b",
  "registry_id": "4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b",
  "kind": "CREATE",
  "status": "PENDING",
  "sku_code": "<sku_code>",
  "quota_bytes": 1,
  "quota_gb": 1,
  "created_at": "2026-10-25T12:00:00Z",
  "effective_at": "2026-10-25T12:00:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.ibee.ai/v1/container-registry/registries/registry_123/upgrade"

querystring = {"workspace_id":"710995"}

payload = { "billing_catalog": { "sku_code": "<sku_code>" } }
headers = {
    "Idempotency-Key": "4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.ibee.ai/v1/container-registry/registries/registry_123/upgrade?workspace_id=710995';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"billing_catalog":{"sku_code":"<sku_code>"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ibee.ai/v1/container-registry/registries/registry_123/upgrade?workspace_id=710995"

	payload := strings.NewReader("{\n  \"billing_catalog\": {\n    \"sku_code\": \"<sku_code>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.ibee.ai/v1/container-registry/registries/registry_123/upgrade?workspace_id=710995")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing_catalog\": {\n    \"sku_code\": \"<sku_code>\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.ibee.ai/v1/container-registry/registries/registry_123/upgrade?workspace_id=710995")
  .header("Idempotency-Key", "4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing_catalog\": {\n    \"sku_code\": \"<sku_code>\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.ibee.ai/v1/container-registry/registries/registry_123/upgrade?workspace_id=710995', [
  'body' => '{
  "billing_catalog": {
    "sku_code": "<sku_code>"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'Idempotency-Key' => '4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.ibee.ai/v1/container-registry/registries/registry_123/upgrade?workspace_id=710995");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"billing_catalog\": {\n    \"sku_code\": \"<sku_code>\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Idempotency-Key": "4f2a9c1e-7b3d-4e8a-9f10-2c5d6e7f8a9b",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["billing_catalog": ["sku_code": "<sku_code>"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.ibee.ai/v1/container-registry/registries/registry_123/upgrade?workspace_id=710995")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```