Skip to navigation

Resize block-storage volume

Block volumes can only be increased in size. 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).
# VOLUME_ID: Workspace-owned block-volume ID
curl -X POST "https://api.ibee.ai/v1/block-storage/volumes/$VOLUME_ID/resize?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"new_size_gb": 1}'

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

volume_idstringRequired>=1 character

Workspace-owned block-volume 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.
new_size_gbintegerRequired1-10000
New size in GB.
vm_stateenum or nullOptional

Current power state of the VM, when the caller knows it.

  • running
  • stopped
  • suspended
Allowed values:
allow_onlinebooleanOptionalDefaults to false
Permit the resize while the volume is attached to a running VM. Default false.
idempotency_keystring or nullOptional

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

Response

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

Errors

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