Attach a volume to a cloud VM

POST

/compute/cloud-vms/:vm_id/actions/attach-volume

Attaches a persistent block volume to the VM. Requires scope: vm.write.

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

vm_idstringRequired

Virtual machine 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.

volume_idstringRequired>=1 character

modeenumOptionalDefaults to single-writer

requested_bystringOptionalDefaults to api

Response

Volume attachment accepted.

operation_idstring

vm_idstring

statusstring

submitted_atdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

$	curl -X POST "https://api.ibee.ai/v1/compute/cloud-vms/vm_id/actions/attach-volume?workspace_id=710995" \
>	-H "X-Idempotency-Key: X-Idempotency-Key" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"volume_id": "string"
>	}'

1	{
2	"operation_id": "op_123",
3	"vm_id": "vm_abc123",
4	"status": "accepted",
5	"submitted_at": "2024-01-15T09:30:00Z"
6	}