Unmount Vm Volume
DELETE /v1/vms/{vm_id}/volumes/{volume_id}
Unmount a volume from a running VM at mount_path. The volume and its data are
kept; a rw mount releases its writer lock so another VM can mount it for
writing, and the mount is removed from the VM's session. With wait=false the
call returns status: pending before the unmount finishes.
Authentication
Requires authentication via: OAuth2PasswordBearer.
Parameters
| Name | In | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
vm_id | path | string | Yes | ||
volume_id | path | string | Yes | ||
mount_path | query | string | Yes | Mounted absolute path for this volume | |
wait | query | boolean | No | Wait for unmount operation to finish | default=true |
X-API-Key | header | string | null | No | nullable |
Responses
200
Successful Response
application/json
Resolved schema:
{}
401
No credentials, or the Bearer token / X-API-Key is invalid.
No response body.
403
The account is disabled, or a guest token was used; or the VM or the volume belongs to another account.
No response body.
404
VM, volume or mount not found.
No response body.
409
The VM is not running, or the mount path is busy.
No response body.
422
Validation Error
application/json
Resolved schema:
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
detail | array<object> | No | ||
detail[] | object | No | ||
detail[].loc | array<string | integer> | No | ||
detail[].loc[] | string | integer | No | ||
detail[].msg | string | No | ||
detail[].type | string | No |
503
Volumes are disabled, the VM is temporarily unreachable, or the unmount failed transiently. Retry later.
No response body.