Get Writable Volumes

Get Writable Volumes

Get Writable Volumes

Request
URI
GET
https://{api_host}/cv_api/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.


Responses
200

List of Writable Volumes along with relevant datastore details.

{
    "datastores": {
        "total_count": 1,
        "warning_count": 0,
        "critical_count": 0,
        "writable": {
            "name": "SSD Disk Array RAID0",
            "datacenter": "DataCenterAPJ",
            "path": "cloudvolumes/writable",
            "current": "true"
        },
        "writable_volumes": [
            {
                "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_name": "TestUser",
                "owner_type": "User",
                "owner_upn": "SNAPVOLUMES\test_user",
                "owner_upn_html": "SNAPVOLUMES\test_user",
                "owner_object_guid": "8da04bfa-bbbe-45c3-9cbf-2d3d03897b84",
                "created_at": "2016-11-23 13:10:13 -0800",
                "created_at_human": "Nov 23 2016",
                "updated_at": "2016-11-23 13:10:13 -0800",
                "updated_at_human": "Nov 23 2016",
                "mounted_at": "2016-11-23 13:10:13 -0800",
                "mounted_at_human": "Nov 23 2016",
                "mount_count": 0,
                "attached": "string",
                "status": "string",
                "size_mb": 312,
                "free_mb": 0,
                "total_mb": 0,
                "percent_available": "Unknown",
                "template_version": "2.10.0.709",
                "filename": "snapvolumes_test_user_15.vmdk",
                "path": "cloudvolumes/writable",
                "datastore_name": "SSD Disk Array RAID8",
                "volume_guid": "volumeguid-8-volumeguid",
                "datastore_host": "null",
                "error_action": "string",
                "busy": false,
                "state": "Moving"
            }
        ]
    }
}
object
datastores
Optional

datastores


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.