Get Writable Volumes

Get Writable Volumes

Get Writable Volumes

Request
URI
GET
https://{api_host}/app_volumes/writables
COPY
Query Parameters
string
volume_guid
Optional

Writable Volume's GUID.

string
user_guid
Optional

Writable Volume's owner's Active Directory Object-Guid.

string
created_after
Optional

DateTime in ISO 8601 format.

string
updated_after
Optional

DateTime in ISO 8601 format.

string
min_capacity
Optional

Minimum capacity to filter in MB.

string
max_capacity
Optional

Maximum capacity to filter in MB.

string
count
Optional

Number of Writable Volumes to limit to in response.

string
owner_name
Optional

owner_name of Writable Volume.

string
owner_type
Optional

owner_type of Writable Volume.

string
domain_name
Optional

domain_name of Writable Volume.

string
status
Optional

status of Writable Volume.

string
attached
Optional

attachment status of Writable Volume.

string
datastore_name
Optional

datastore_name in which Writable Volume exists.

string
datacenter_name
Optional

datacenter_name in which Writable Volume exists.

string
migrated
Optional

migration status of Writable Volume.

Responses
200

List of Writable Volumes.

Returns GetWritableVolumes of type(s) application/json 
{
    "data": [
        {
            "id": 0,
            "name": "SNAPVOLUMES\test_user",
            "title": "SNAPVOLUMES\test_user",
            "owner_id": 2,
            "owner_name": "TestUser",
            "owner_type": "User",
            "owner_upn": "SNAPVOLUMES\test_user",
            "owner_object_guid": "8da04bfa-bbbe-45c3-9cbf-2d3d03897b84",
            "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",
            "attached": "string",
            "status": "string",
            "mount_count": 0,
            "total_mb": 10237,
            "free_mb": 5237,
            "size_mb": 5000,
            "requested_mb": 20480,
            "percent_available": "Unknown",
            "template_version": "4.0.0",
            "version_count": 0,
            "type": "DataDisk",
            "display_type": "Writable Volume",
            "error_action": "string",
            "busy": false,
            "state": "Moving",
            "filename": "snapvolumes_test_user.vmdk",
            "path": "appvolumes/writable",
            "datastore_name": "SSD Disk Array RAID8",
            "volume_guid": "volumeguid-8-volumeguid",
            "datastore_host": "null",
            "can_expand": true
        }
    ],
    "counts": {
        "total": 1,
        "warning": 0,
        "critical": 0
    }
}
array of WritableVolumeForIndex
data
Optional

data

object
counts
Optional

counts


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.


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.


On This Page
Writable Volumes Operations
DELETE
Delete A Writable Volume
GET
Get A Writable Volume By ID
GET
Get Writable Volumes
POST
Increase size Of A given Writable Volume
PUT
Update A Writable Volume By ID