List block storage plans

GET

/block-storage/plans

GET

/v1/block-storage/plans

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl "https://api.ibee.ai/v1/block-storage/plans?workspace_id=$WORKSPACE_ID" \
  -H "Authorization: Bearer $IBEE_API_TOKEN"

{
  "items": [
    {
      "sku_code": "<sku_code>",
      "name": "<name>",
      "id": "<id>",
      "plan_code": "<plan_code>",
      "description": "<description>",
      "storage_type": "<storage_type>",
      "status": "<status>",
      "selectable": true,
      "included_usage": {
        "min_size_gb": 1,
        "max_size_gb": 1,
        "allowed_sizes_gb": [],
        "price_per_gb_month": 1,
        "price_per_gb_month_minor": 1,
        "iops": 1,
        "throughput_mibps": 1
      }
    }
  ],
  "currency": "<currency>",
  "billing_interval": "<billing_interval>"
}

Returns the block storage plans with their sizes, performance and prices, as the portal’s Create Volume page shows them. Pick a sku_code for createBlockVolume. Requires scope: block-storage.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl "https://api.ibee.ai/v1/block-storage/plans?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.

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.

site_idstringOptional

Return only plans offered at this site.

currencystringOptionalDefaults to INR

Price currency. Default INR.

billing_intervalenumOptionalDefaults to MONTHLY

Billing interval of the listed prices. Default MONTHLY.

Allowed values:

Response

Plans returned successfully.

itemslist of objects

currencystringOptional

billing_intervalstringOptional

Errors

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error