Skip to navigation

Create block-storage volume

The public edge resolves authoritative pricing from the server-owned product catalog and validates billing before forwarding this request to the existing portal volume flow. Client-supplied price or billing catalog objects are not accepted. Asynchronous: the response carries the volume operation; poll GET /block-storage/volumes/{volume_id}/operations until its status is succeeded or failed.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl -X POST "https://api.ibee.ai/v1/block-storage/volumes?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "<name>", "size_gb": 1, "site_id": "68b99bd78a8eda32ff3f16ea"}'

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.

Request

This endpoint expects an object.
namestringRequired1-255 characters

Display name of the volume (1-255 characters).

size_gbintegerRequired1-10000

Size in GB (1-10000).

site_idstringRequired>=1 character
Site to create the volume at.
site_namestring or nullOptional
Display name of that site, as shown in the portal.
sku_codestring or nullOptional

Optional public selector returned by the server-owned Block Storage catalog. The edge resolves all price and catalog metadata; callers cannot submit pricing.

volume_classenumOptionalDefaults to balanced

Performance class of the volume.

  • capacity: lowest cost per GB.
  • balanced: general purpose.
  • performance: highest throughput and IOPS. Default balanced.
Allowed values:
replica_countintegerOptional1-5Defaults to 2

Number of synchronous replicas kept for the volume (1-5). Default 2.

backup_enabledbooleanOptionalDefaults to true
Whether volume backups are enabled. Default true.
idempotency_keystring or nullOptional

Caller-chosen key that makes a retried request return the original operation instead of starting a new one.

Response

Volume created successfully.
volumeobject
A block storage volume.
operationobject
One operation run on a volume.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
413
Content Too Large Error
422
Unprocessable Entity Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error