Delete A Writable Volume
Delete a Writable Volume
Request
URI
DELETE
https://{api_host}/app_volumes/writables/{id}
COPY
Path Parameters
integer
id
Required
Writable Volume ID.
Responses
200
Deleted the Writable Volume.
Returns DeleteWritableVolume of type(s) application/json
{
"success": "Deleted 1 volume",
"error": "Unable to delete 1 volume",
"snapvols": {
"not_found": [
{
"id": 0,
"name": "SNAPVOLUMES\test_user",
"name_html": "SNAPVOLUMES\test_user",
"title": "SNAPVOLUMES\test_user",
"title_html": "SNAPVOLUMES\test_user",
"owner": "<a href=\\\"/directory#/Users/2\\\" title=\\\"test_user\\\">TESTDOMAIN\\\\test_user</a>",
"link": "/directory#/Users/2",
"owner_id": 3,
"owner_name": "TestUser",
"owner_type": "User",
"owner_upn": "SNAPVOLUMES\test_user",
"owner_upn_html": "SNAPVOLUMES\test_user",
"owner_object_guid": "8da04bfa-bbbe-45c3-9cbf-2d3d03897b84",
"description": "My writable volume",
"created_at": "2021-12-03 13:10:13 -0800",
"created_at_human": "Dec 03 2021",
"updated_at": "2021-12-03 13:10:13 -0800",
"updated_at_human": "Dec 03 2021",
"mounted_at": "2021-12-03 13:10:13 -0800",
"mounted_at_human": "Dec 03 2021",
"mounted_on": "Machine <DESKTOP-VM123> (#{1234567812345678})",
"mount_count": 0,
"attached": "string",
"status": "enabled",
"version_count": 0,
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": false,
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": false,
"state": "Moving",
"volume_guid": "volumeguid-8-volumeguid",
"datastore_name": "SSD Disk Array RAID8",
"machine_manager_host": "0.0.0.0",
"machine_manager_type": "Machine Manager",
"path": "appvolumes/writable",
"filename": "snapvolumes_test_user_15.vmdk",
"file_location": "[SSD Disk Array RAID8] appvolumes/writable/snapvolumes_test_user_15.vmdk",
"type": "DataDisk",
"display_type": "Writable Volume",
"files_count": 1,
"template_file_name": "[SSD Disk Array RAID8] appvolumes/writable_templates/template_uia_only_persistent.vmdk",
"protected": true,
"percent_available": "Unknown",
"can_expand": true,
"datastore_host": "null",
"primordial_os_id": 15,
"primordial_os_name": "Windows 8.1 (x64)",
"oses": [
{
"id": 0,
"name": "Windows 8.1 (x64)"
}
]
}
],
"success": [
{
"id": 0,
"name": "SNAPVOLUMES\test_user",
"name_html": "SNAPVOLUMES\test_user",
"title": "SNAPVOLUMES\test_user",
"title_html": "SNAPVOLUMES\test_user",
"owner": "<a href=\\\"/directory#/Users/2\\\" title=\\\"test_user\\\">TESTDOMAIN\\\\test_user</a>",
"link": "/directory#/Users/2",
"owner_id": 3,
"owner_name": "TestUser",
"owner_type": "User",
"owner_upn": "SNAPVOLUMES\test_user",
"owner_upn_html": "SNAPVOLUMES\test_user",
"owner_object_guid": "8da04bfa-bbbe-45c3-9cbf-2d3d03897b84",
"description": "My writable volume",
"created_at": "2021-12-03 13:10:13 -0800",
"created_at_human": "Dec 03 2021",
"updated_at": "2021-12-03 13:10:13 -0800",
"updated_at_human": "Dec 03 2021",
"mounted_at": "2021-12-03 13:10:13 -0800",
"mounted_at_human": "Dec 03 2021",
"mounted_on": "Machine <DESKTOP-VM123> (#{1234567812345678})",
"mount_count": 0,
"attached": "string",
"status": "enabled",
"version_count": 0,
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": false,
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": false,
"state": "Moving",
"volume_guid": "volumeguid-8-volumeguid",
"datastore_name": "SSD Disk Array RAID8",
"machine_manager_host": "0.0.0.0",
"machine_manager_type": "Machine Manager",
"path": "appvolumes/writable",
"filename": "snapvolumes_test_user_15.vmdk",
"file_location": "[SSD Disk Array RAID8] appvolumes/writable/snapvolumes_test_user_15.vmdk",
"type": "DataDisk",
"display_type": "Writable Volume",
"files_count": 1,
"template_file_name": "[SSD Disk Array RAID8] appvolumes/writable_templates/template_uia_only_persistent.vmdk",
"protected": true,
"percent_available": "Unknown",
"can_expand": true,
"datastore_host": "null",
"primordial_os_id": 15,
"primordial_os_name": "Windows 8.1 (x64)",
"oses": [
{
"id": 0,
"name": "Windows 8.1 (x64)"
}
]
}
],
"error": [
{
"id": 0,
"name": "SNAPVOLUMES\test_user",
"name_html": "SNAPVOLUMES\test_user",
"title": "SNAPVOLUMES\test_user",
"title_html": "SNAPVOLUMES\test_user",
"owner": "<a href=\\\"/directory#/Users/2\\\" title=\\\"test_user\\\">TESTDOMAIN\\\\test_user</a>",
"link": "/directory#/Users/2",
"owner_id": 3,
"owner_name": "TestUser",
"owner_type": "User",
"owner_upn": "SNAPVOLUMES\test_user",
"owner_upn_html": "SNAPVOLUMES\test_user",
"owner_object_guid": "8da04bfa-bbbe-45c3-9cbf-2d3d03897b84",
"description": "My writable volume",
"created_at": "2021-12-03 13:10:13 -0800",
"created_at_human": "Dec 03 2021",
"updated_at": "2021-12-03 13:10:13 -0800",
"updated_at_human": "Dec 03 2021",
"mounted_at": "2021-12-03 13:10:13 -0800",
"mounted_at_human": "Dec 03 2021",
"mounted_on": "Machine <DESKTOP-VM123> (#{1234567812345678})",
"mount_count": 0,
"attached": "string",
"status": "enabled",
"version_count": 0,
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": false,
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": false,
"state": "Moving",
"volume_guid": "volumeguid-8-volumeguid",
"datastore_name": "SSD Disk Array RAID8",
"machine_manager_host": "0.0.0.0",
"machine_manager_type": "Machine Manager",
"path": "appvolumes/writable",
"filename": "snapvolumes_test_user_15.vmdk",
"file_location": "[SSD Disk Array RAID8] appvolumes/writable/snapvolumes_test_user_15.vmdk",
"type": "DataDisk",
"display_type": "Writable Volume",
"files_count": 1,
"template_file_name": "[SSD Disk Array RAID8] appvolumes/writable_templates/template_uia_only_persistent.vmdk",
"protected": true,
"percent_available": "Unknown",
"can_expand": true,
"datastore_host": "null",
"primordial_os_id": 15,
"primordial_os_name": "Windows 8.1 (x64)",
"oses": [
{
"id": 0,
"name": "Windows 8.1 (x64)"
}
]
}
],
"scheduled": [
{
"id": 0,
"name": "SNAPVOLUMES\test_user",
"name_html": "SNAPVOLUMES\test_user",
"title": "SNAPVOLUMES\test_user",
"title_html": "SNAPVOLUMES\test_user",
"owner": "<a href=\\\"/directory#/Users/2\\\" title=\\\"test_user\\\">TESTDOMAIN\\\\test_user</a>",
"link": "/directory#/Users/2",
"owner_id": 3,
"owner_name": "TestUser",
"owner_type": "User",
"owner_upn": "SNAPVOLUMES\test_user",
"owner_upn_html": "SNAPVOLUMES\test_user",
"owner_object_guid": "8da04bfa-bbbe-45c3-9cbf-2d3d03897b84",
"description": "My writable volume",
"created_at": "2021-12-03 13:10:13 -0800",
"created_at_human": "Dec 03 2021",
"updated_at": "2021-12-03 13:10:13 -0800",
"updated_at_human": "Dec 03 2021",
"mounted_at": "2021-12-03 13:10:13 -0800",
"mounted_at_human": "Dec 03 2021",
"mounted_on": "Machine <DESKTOP-VM123> (#{1234567812345678})",
"mount_count": 0,
"attached": "string",
"status": "enabled",
"version_count": 0,
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": false,
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": false,
"state": "Moving",
"volume_guid": "volumeguid-8-volumeguid",
"datastore_name": "SSD Disk Array RAID8",
"machine_manager_host": "0.0.0.0",
"machine_manager_type": "Machine Manager",
"path": "appvolumes/writable",
"filename": "snapvolumes_test_user_15.vmdk",
"file_location": "[SSD Disk Array RAID8] appvolumes/writable/snapvolumes_test_user_15.vmdk",
"type": "DataDisk",
"display_type": "Writable Volume",
"files_count": 1,
"template_file_name": "[SSD Disk Array RAID8] appvolumes/writable_templates/template_uia_only_persistent.vmdk",
"protected": true,
"percent_available": "Unknown",
"can_expand": true,
"datastore_host": "null",
"primordial_os_id": 15,
"primordial_os_name": "Windows 8.1 (x64)",
"oses": [
{
"id": 0,
"name": "Windows 8.1 (x64)"
}
]
}
]
}
}string
success
Optional
Success details.
string
error
Optional
Failure details.
400
ID missing from request.
{
"error": "Missing parameters"
}string
error
Optional
Failure details.
403
Session expired. Create a session and make the request with the _session_id cookie.
Returns UnauthorizedError of type(s) application/json
{
"error": "Session expired. Please login again."
}string
error
Optional
Session expired. Create a session using and make the request with the _session_id cookie.
404
Writable Volume was not found.
Returns DeleteWritableVolumeNotFound of type(s) application/json
{
"error": "Unable to delete 1 volume because record does not exist.",
"snapvols": {
"not_found": [
0
],
"success": [],
"error": [],
"scheduled": []
}
}string
error
Optional
Failure details.
object
snapvols
Optional
snapvols
500
Server error.
Returns ServerError of type(s) application/json
{
"error": "Server Error",
"detail": "Unexpected server error."
}string
error
Optional
Server Error.
string
detail
Optional
Details of error. Exact error format subject to change depending on type of error.