App Volumes API Data Structures
{
"source_id": "integer",
"source_type": "User",
"source_name": "Administrator",
"source_url": "/directory#/Users/1",
"target_id": "integer",
"target_type": "Snapvol",
"target_name": "Administrator",
"target_description": "Administrator",
"target_url": "/directory#/Users/1",
"action": "Assign",
"log": "Success",
"event_time": "2022-01-01 12:00:00 -0700",
"event_time_human": "January 1, 2022 12:00PM",
"admin_user_upn": "DOMAIN\\Administrator",
"admin_user_name": "Administrator",
"admin_user_url": "/directory#/Users/2",
"id": 1
}
The source record ID.
Type of the source record.
Intended as human readable name for the source record.
When available, URL to the source record in App Volumes Manager UI.
The target record ID.
Type of the target record.
Intended as human readable name for the target record.
Descriptive text for the target record.
When available, URL to the target record in App Volumes Manager UI.
Description of the event.
Event result.
When did the event happened.
Event timestamp human readable format.
Down-level login name of the admin user.
Name the admin user.
When available, URL to the admin user record in App Volumes Manager UI.
The Activity log record id.
A collection of audit records.
[
{
"source_id": "integer",
"source_type": "User",
"source_name": "Administrator",
"source_url": "/directory#/Users/1",
"target_id": "integer",
"target_type": "Snapvol",
"target_name": "Administrator",
"target_description": "Administrator",
"target_url": "/directory#/Users/1",
"action": "Assign",
"log": "Success",
"event_time": "2022-01-01 12:00:00 -0700",
"event_time_human": "January 1, 2022 12:00PM",
"admin_user_upn": "DOMAIN\\Administrator",
"admin_user_name": "Administrator",
"admin_user_url": "/directory#/Users/2",
"id": 1
}
]
Timestamp of record addition.
Timestamp of record addition in human readable format.
The api_version supported for api
{
"id": "integer",
"description": "This application is best suitable for text files.",
"app_product_id": "integer",
"app_product_name": "Notepad++",
"app_package_id": "integer",
"app_package_name": "Notepad-7.0.1",
"app_marker_id": "integer",
"app_marker_name": "CURRENT",
"priority": "integer",
"mount_prefix": "string",
"delivery": "default",
"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",
"filters": [
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
The Application Assignment ID.
The description of Application.
The Application ID.
The Application name.
The Package ID.
The Package name.
The Marker ID.
The Marker name.
Priority of Application assignment.
Mount prefix for the assignment.
The delivery mode set for App Assignment.
[
{
"app_product_id": 1,
"entities": [
{
"entity_type": "Group",
"path": "CN=test1,CN=Users,DC=test,DC=local"
}
],
"app_package_id": "integer",
"app_marker_id": 1,
"delivery": "default",
"filters": [
{
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
]
deleted/not_deleted array shows AppAssignment IDs which are deleted/not_deleted respectively.
{
"deleted": [
{
"id": 1
}
],
"not_deleted": [
{
"id": 1
}
]
}
{
"data": [
{
"type": "app_assignment_entities",
"id": 1
}
]
}
data
AppAssignment ID.
An array of AppAssignment IDs in integer form.
[
{}
]
AppAssignment ID.
{
"id": 1
}
id
An array of AppAssignment IDs in object form.
[
{
"id": 1
}
]
{
"app_product_id": 1,
"entities": [
{
"entity_type": "Group",
"path": "CN=test1,CN=Users,DC=test,DC=local"
}
],
"app_package_id": "integer",
"app_marker_id": 1,
"delivery": "default",
"filters": [
{
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
The ID of the Application to assign or unassign.
The ID of the Package if this is a Package Assignment.
The ID of the Marker if this is a Marker Assignment.
The delivery mode set for App Assignment.
{
"first": "http://localhost:3000/app_volumes/app_assignments?include=app_assignment_entities%2Cassignment_filters%2Capp_marker%2Capp_package%2Capp_marker.app_package%2Capp_product%2Capp_assignment_entities.target&page%5Bnumber%5D=1&page%5Bsize%5D=3",
"next": "http://localhost:3000/app_volumes/app_assignments?include=app_assignment_entities%2Cassignment_filters%2Capp_marker%2Capp_package%2Capp_marker.app_package%2Capp_product%2Capp_assignment_entities.target&page%5Bnumber%5D=2&page%5Bsize%5D=3",
"last": "http://localhost:3000/app_volumes/app_assignments?include=app_assignment_entities%2Cassignment_filters%2Capp_marker%2Capp_package%2Capp_marker.app_package%2Capp_product%2Capp_assignment_entities.target&page%5Bnumber%5D=6&page%5Bsize%5D=3"
}
The link for first page.
The link for next available page.
The link for last page.
{
"total": 18,
"filtered": 18,
"page_count": 6
}
The number of total records before filtering (i.e. the total number of records in the database).
The number of total records after filtering (i.e. the total number of records after filtering has been applied, not just the number of records being returned for this page of data).
The number of pages available for app assignments.
{
"data": [
{
"app_product_id": 1,
"entities": [
{
"entity_type": "Group",
"path": "CN=test1,CN=Users,DC=test,DC=local"
}
],
"app_package_id": "integer",
"app_marker_id": 1,
"delivery": "default",
"filters": [
{
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
]
}
{
"data": [
{
"id": "integer",
"description": "This application is best suitable for text files.",
"app_product_id": "integer",
"app_product_name": "Notepad++",
"app_package_id": "integer",
"app_package_name": "Notepad-7.0.1",
"app_marker_id": "integer",
"app_marker_name": "CURRENT",
"priority": "integer",
"mount_prefix": "string",
"delivery": "default",
"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",
"filters": [
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
]
}
A collection of app-assignments.
[
{
"id": "integer",
"description": "This application is best suitable for text files.",
"app_product_id": "integer",
"app_product_name": "Notepad++",
"app_package_id": "integer",
"app_package_name": "Notepad-7.0.1",
"app_marker_id": "integer",
"app_marker_name": "CURRENT",
"priority": "integer",
"mount_prefix": "string",
"delivery": "default",
"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",
"filters": [
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
]
{
"data": {
"type": "app_markers",
"id": 1
}
}
data
{
"data": {
"type": "app_packages",
"id": 1
}
}
data
{
"data": {
"type": "app_products",
"id": 1
}
}
data
{
"data": {
"deleted": [
{
"id": 1
}
],
"not_deleted": [
{
"id": 1
}
]
}
}
{
"errors": [
{
"title": "Unable to create assignment. Package must be enabled",
"meta": {
"manager": {
"title": "Unable to create assignment. Package must be enabled"
}
}
},
{
"title": "Unable to save assignment",
"meta": {
"manager": {
"title": "Unable to save assignment"
}
}
},
{
"title": "Unable to create duplicate assignment with entity SNAPVOLUMES\\test-user to the same application",
"meta": {
"manager": {
"title": "Unable to create duplicate assignment with entity SNAPVOLUMES\\test-user to the same application"
}
}
},
{
"title": "Invalid delivery mode 'custom_mode' passed, it must belong to: [\"default\", \"on_trigger\"]",
"meta": {
"manager": {
"title": "Invalid delivery mode 'custom_mode' passed, it must belong to: [\"default\", \"on_trigger\"]"
}
}
}
]
}
errors
{
"id": "integer",
"name": "Notepad++",
"guid": "1b38f44f-cb39-46fa-bcac-d72af508ddee",
"icon": "string",
"assignment_count": 1,
"description": "This application is best suitable for text files.",
"app_packages_count": "integer",
"app_packages": [
{
"id": "integer",
"name": "Notepad-7.0.1",
"guid": "14848eb3-169b-4e8a-bcb7-556f1811c08c",
"app_product_id": 3,
"lifecycle_stage_id": 1,
"state": "Package",
"version": "7.0.1",
"description": "This package is on its latest version 7.0.1",
"note": "The Package is best suited for development and HR dept.",
"display_delivery": "Classic",
"delivery": "classic",
"capable_of_on_demand": true,
"status": "enabled",
"programs_count": 2,
"icon": "/snapvols/9/Notepad++.7.0.1.png",
"operating_systems_count": "integer",
"delete_status": "deleting",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"added_at": "2021-12-03 13:10:13 -0800",
"added_at_human": "Dec 04 2021",
"attachment_count": 2,
"type": "AppPackage",
"format": "AV",
"path": "appvolumes/packages",
"filename": "Notepad++.vmdk",
"enabled": true,
"writable": "boolean",
"datastore_name": "datastore1",
"files_count": 2,
"total_use_count": 5,
"provision_uuid": "string",
"provisioning": "boolean",
"provision_completed_at": "2021-08-17 10:32:32 +0530",
"provision_started_at": "2021-08-17 10:30:26 +0530",
"size_mb": 73,
"size_human": "83.00 MB",
"assignment_count": 1,
"volume_guid": "{4f949610-35c1-4e52-9f71-89d899150007}",
"snapvol_version_id": "integer",
"mount_prefix": "string",
"mounted_at": "2021-08-17 11:00:32 +0530",
"template_file_name": "[data.1] appvolumes/packages_templates/template.vmdk",
"template_version": "2.10.0.709",
"missing": "boolean",
"protected": true,
"agent_version": "4.5.0.922D",
"capture_version": "4.0",
"free_mb": "integer",
"total_mb": "integer",
"attachment_limit": 2,
"reachable": true,
"provision_duration": "2 minutes",
"primordial_os_id": 2,
"primordial_os_name": "Windows 10 (x64)"
}
],
"owner_guid": "5F02DE3B-BAB1-4FDB-8065-ABB8711013EF",
"status": "active",
"delete_status": "deleting",
"sync_status": "string",
"sync_message": "string",
"synced_at": "2021-12-03 13:10:13 -0800",
"synced_at_human": "Dec 03 2021",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"metadata_sync_at": "2021-12-03 15:10:14 -0800",
"metadata_sync_at_human": "Dec 03 2021",
"metadata_properties_updated_at": "2021-12-03 15:10:14 -0800",
"metadata_properties_updated_at_human": "Dec 03 2021",
"metadata_version": "string"
}
The Application ID.
The Application name.
The Application guid.
The Application icon.
The assignment count for Application.
The description of Application.
The app_package count for Application.
The Application owner_guid.
The Application status.
The Application delete_status.
The Application sync_status.
The Application sync_message.
metadata_properties_updated_at
metadata_properties_updated_at_human
The Application metadata_version.
Application ID.
Application Metadata Properties update timestamp.
Application Metadata Properties update timestamp in human readable format.
Application Metadata Sync timestamp.
Application Metadata Sync timestamp in human readable format.
Application Sync timestamp.
Application Sync timestamp in human readable format.
{
"error": "Missing required ids parameter"
}
When parameter ids is missing.
A collection of Applications.
[
{
"id": "integer",
"name": "Notepad++",
"guid": "1b38f44f-cb39-46fa-bcac-d72af508ddee",
"icon": "string",
"assignment_count": 1,
"description": "This application is best suitable for text files.",
"app_packages_count": "integer",
"app_packages": [
{
"id": "integer",
"name": "Notepad-7.0.1",
"guid": "14848eb3-169b-4e8a-bcb7-556f1811c08c",
"app_product_id": 3,
"lifecycle_stage_id": 1,
"state": "Package",
"version": "7.0.1",
"description": "This package is on its latest version 7.0.1",
"note": "The Package is best suited for development and HR dept.",
"display_delivery": "Classic",
"delivery": "classic",
"capable_of_on_demand": true,
"status": "enabled",
"programs_count": 2,
"icon": "/snapvols/9/Notepad++.7.0.1.png",
"operating_systems_count": "integer",
"delete_status": "deleting",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"added_at": "2021-12-03 13:10:13 -0800",
"added_at_human": "Dec 04 2021",
"attachment_count": 2,
"type": "AppPackage",
"format": "AV",
"path": "appvolumes/packages",
"filename": "Notepad++.vmdk",
"enabled": true,
"writable": "boolean",
"datastore_name": "datastore1",
"files_count": 2,
"total_use_count": 5,
"provision_uuid": "string",
"provisioning": "boolean",
"provision_completed_at": "2021-08-17 10:32:32 +0530",
"provision_started_at": "2021-08-17 10:30:26 +0530",
"size_mb": 73,
"size_human": "83.00 MB",
"assignment_count": 1,
"volume_guid": "{4f949610-35c1-4e52-9f71-89d899150007}",
"snapvol_version_id": "integer",
"mount_prefix": "string",
"mounted_at": "2021-08-17 11:00:32 +0530",
"template_file_name": "[data.1] appvolumes/packages_templates/template.vmdk",
"template_version": "2.10.0.709",
"missing": "boolean",
"protected": true,
"agent_version": "4.5.0.922D",
"capture_version": "4.0",
"free_mb": "integer",
"total_mb": "integer",
"attachment_limit": 2,
"reachable": true,
"provision_duration": "2 minutes",
"primordial_os_id": 2,
"primordial_os_name": "Windows 10 (x64)"
}
],
"owner_guid": "5F02DE3B-BAB1-4FDB-8065-ABB8711013EF",
"status": "active",
"delete_status": "deleting",
"sync_status": "string",
"sync_message": "string",
"synced_at": "2021-12-03 13:10:13 -0800",
"synced_at_human": "Dec 03 2021",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"metadata_sync_at": "2021-12-03 15:10:14 -0800",
"metadata_sync_at_human": "Dec 03 2021",
"metadata_properties_updated_at": "2021-12-03 15:10:14 -0800",
"metadata_properties_updated_at_human": "Dec 03 2021",
"metadata_version": "string"
}
]
{
"id": 1,
"description": "This application is best suitable for text files.",
"app_product_id": 1,
"app_product_name": "Notepad++",
"app_package_id": "integer",
"app_package_name": "string",
"app_marker_id": 1,
"app_marker_name": "CURRENT",
"priority": "integer",
"mount_prefix": "string",
"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",
"entities": [
{
"id": 1,
"entity_type": "User",
"name": "testuser-1",
"account_name": "testuser-1",
"upn": "SNAPVOLUMES\\testuser-1",
"distinguished_name": "CN=testuser-1,OU=Domain Users,DC=Snapvolumes,DC=com"
}
],
"filters": [
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
The Application Assignment ID.
The description of Application.
The Application ID.
The Application name.
The Package ID.
The Package name.
The Marker ID.
The Marker name.
Priority of Application assignment.
Mount prefix for the assignment.
A collection of assignments for an Application.
[
{
"id": 1,
"description": "This application is best suitable for text files.",
"app_product_id": 1,
"app_product_name": "Notepad++",
"app_package_id": "integer",
"app_package_name": "string",
"app_marker_id": 1,
"app_marker_name": "CURRENT",
"priority": "integer",
"mount_prefix": "string",
"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",
"entities": [
{
"id": 1,
"entity_type": "User",
"name": "testuser-1",
"account_name": "testuser-1",
"upn": "SNAPVOLUMES\\testuser-1",
"distinguished_name": "CN=testuser-1,OU=Domain Users,DC=Snapvolumes,DC=com"
}
],
"filters": [
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
]
{
"data": [
{
"type": "assignment_filters",
"id": 1
}
]
}
data
{
"entity_type": "Group",
"path": "CN=test1,CN=Users,DC=test,DC=local"
}
Type of the entity can be either organizational unit, group, user or computer.
Active Directory path of the entity.
{
"type": "ComputerPrefixFilter",
"value": "COMP"
}
Type of Prefix filter.
Value of Prefix filter.
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
ID of ComputerPrefixFilter.
Type of Prefix filter.
Value of Prefix filter.
Creation timestamp.
Creation timestamp in human readable format.
{
"success": "Deleted 1 volume",
"error": "Unable to delete 1 volume",
"snapvols": {
"not_found": [
{
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
],
"success": [
{
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
],
"error": [
{
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
],
"scheduled": [
{
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
]
}
}
Success details.
Failure details.
{
"error": "Unable to delete 1 volume because record does not exist.",
"snapvols": {
"not_found": [
"integer"
],
"success": [],
"error": [],
"scheduled": []
}
}
Failure details.
snapvols
Deletion timestamp.
Deletion timestamp in human readable format.
{
"id": 1,
"entity_type": "User",
"name": "testuser-1",
"account_name": "testuser-1",
"upn": "SNAPVOLUMES\\testuser-1",
"distinguished_name": "CN=testuser-1,OU=Domain Users,DC=Snapvolumes,DC=com"
}
ID of entity.
The type of entity (i.e. User, Computer, Group, OU).
The name of entity.
The account-name of entity.
The upn for entity.
The full dn for entity in AD.
{
"errors": [
{
"title": "Invalid page value",
"detail": "0 is not a valid value for number page parameter.",
"code": 118,
"status": 400
}
]
}
errors
{
"data": [
{
"id": 1,
"type": "app_assignments",
"links": {
"self": "http://localhost:3000/app_volumes/app_assignments/1"
},
"attributes": {
"app_marker_id": "integer",
"app_product_id": "integer",
"app_package_id": "integer",
"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",
"delivery": "default"
},
"relationships": {
"app_product": {
"data": {
"type": "app_products",
"id": 1
}
},
"app_marker": {
"data": {
"type": "app_markers",
"id": 1
}
},
"app_package": {
"data": {
"type": "app_packages",
"id": 1
}
},
"app_assignment_entities": {
"data": [
{
"type": "app_assignment_entities",
"id": 1
}
]
},
"assignment_filters": {
"data": [
{
"type": "assignment_filters",
"id": 1
}
]
}
}
}
],
"included": [
{
"id": 1,
"type": "app_packages",
"attributes": {
"name": "Notepad++ 7.2.0",
"guid": "b9421adb-d6cb-47f0-81ba-10718d3a8611",
"app_product_id": 1,
"state": "Package",
"version": "7.2.0",
"programs_count": 1,
"operating_systems_count": 1,
"description": "string"
}
}
],
"meta": {
"total": 18,
"filtered": 18,
"page_count": 6
},
"links": {
"first": "http://localhost:3000/app_volumes/app_assignments?include=app_assignment_entities%2Cassignment_filters%2Capp_marker%2Capp_package%2Capp_marker.app_package%2Capp_product%2Capp_assignment_entities.target&page%5Bnumber%5D=1&page%5Bsize%5D=3",
"next": "http://localhost:3000/app_volumes/app_assignments?include=app_assignment_entities%2Cassignment_filters%2Capp_marker%2Capp_package%2Capp_marker.app_package%2Capp_product%2Capp_assignment_entities.target&page%5Bnumber%5D=2&page%5Bsize%5D=3",
"last": "http://localhost:3000/app_volumes/app_assignments?include=app_assignment_entities%2Cassignment_filters%2Capp_marker%2Capp_package%2Capp_marker.app_package%2Capp_product%2Capp_assignment_entities.target&page%5Bnumber%5D=6&page%5Bsize%5D=3"
}
}
{
"data": [
{
"id": 1,
"description": "This application is best suitable for text files.",
"app_product_id": 1,
"app_product_name": "Notepad++",
"app_package_id": "integer",
"app_package_name": "string",
"app_marker_id": 1,
"app_marker_name": "CURRENT",
"priority": "integer",
"mount_prefix": "string",
"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",
"entities": [
{
"id": 1,
"entity_type": "User",
"name": "testuser-1",
"account_name": "testuser-1",
"upn": "SNAPVOLUMES\\testuser-1",
"distinguished_name": "CN=testuser-1,OU=Domain Users,DC=Snapvolumes,DC=com"
}
],
"filters": [
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
]
}
{
"errors": [
{
"title": "Application \"0\" was not found",
"meta": {
"manager": {
"title": "Application \"0\" was not found"
}
}
}
]
}
errors
{
"data": {
"id": "integer",
"name": "Notepad++",
"guid": "1b38f44f-cb39-46fa-bcac-d72af508ddee",
"icon": "string",
"assignment_count": 1,
"description": "This application is best suitable for text files.",
"app_packages_count": "integer",
"app_packages": [
{
"id": "integer",
"name": "Notepad-7.0.1",
"guid": "14848eb3-169b-4e8a-bcb7-556f1811c08c",
"app_product_id": 3,
"lifecycle_stage_id": 1,
"state": "Package",
"version": "7.0.1",
"description": "This package is on its latest version 7.0.1",
"note": "The Package is best suited for development and HR dept.",
"display_delivery": "Classic",
"delivery": "classic",
"capable_of_on_demand": true,
"status": "enabled",
"programs_count": 2,
"icon": "/snapvols/9/Notepad++.7.0.1.png",
"operating_systems_count": "integer",
"delete_status": "deleting",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"added_at": "2021-12-03 13:10:13 -0800",
"added_at_human": "Dec 04 2021",
"attachment_count": 2,
"type": "AppPackage",
"format": "AV",
"path": "appvolumes/packages",
"filename": "Notepad++.vmdk",
"enabled": true,
"writable": "boolean",
"datastore_name": "datastore1",
"files_count": 2,
"total_use_count": 5,
"provision_uuid": "string",
"provisioning": "boolean",
"provision_completed_at": "2021-08-17 10:32:32 +0530",
"provision_started_at": "2021-08-17 10:30:26 +0530",
"size_mb": 73,
"size_human": "83.00 MB",
"assignment_count": 1,
"volume_guid": "{4f949610-35c1-4e52-9f71-89d899150007}",
"snapvol_version_id": "integer",
"mount_prefix": "string",
"mounted_at": "2021-08-17 11:00:32 +0530",
"template_file_name": "[data.1] appvolumes/packages_templates/template.vmdk",
"template_version": "2.10.0.709",
"missing": "boolean",
"protected": true,
"agent_version": "4.5.0.922D",
"capture_version": "4.0",
"free_mb": "integer",
"total_mb": "integer",
"attachment_limit": 2,
"reachable": true,
"provision_duration": "2 minutes",
"primordial_os_id": 2,
"primordial_os_name": "Windows 10 (x64)"
}
],
"owner_guid": "5F02DE3B-BAB1-4FDB-8065-ABB8711013EF",
"status": "active",
"delete_status": "deleting",
"sync_status": "string",
"sync_message": "string",
"synced_at": "2021-12-03 13:10:13 -0800",
"synced_at_human": "Dec 03 2021",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"metadata_sync_at": "2021-12-03 15:10:14 -0800",
"metadata_sync_at_human": "Dec 03 2021",
"metadata_properties_updated_at": "2021-12-03 15:10:14 -0800",
"metadata_properties_updated_at_human": "Dec 03 2021",
"metadata_version": "string"
}
}
{
"data": [
{
"id": "integer",
"name": "Notepad++",
"guid": "1b38f44f-cb39-46fa-bcac-d72af508ddee",
"icon": "string",
"assignment_count": 1,
"description": "This application is best suitable for text files.",
"app_packages_count": "integer",
"app_packages": [
{
"id": "integer",
"name": "Notepad-7.0.1",
"guid": "14848eb3-169b-4e8a-bcb7-556f1811c08c",
"app_product_id": 3,
"lifecycle_stage_id": 1,
"state": "Package",
"version": "7.0.1",
"description": "This package is on its latest version 7.0.1",
"note": "The Package is best suited for development and HR dept.",
"display_delivery": "Classic",
"delivery": "classic",
"capable_of_on_demand": true,
"status": "enabled",
"programs_count": 2,
"icon": "/snapvols/9/Notepad++.7.0.1.png",
"operating_systems_count": "integer",
"delete_status": "deleting",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"added_at": "2021-12-03 13:10:13 -0800",
"added_at_human": "Dec 04 2021",
"attachment_count": 2,
"type": "AppPackage",
"format": "AV",
"path": "appvolumes/packages",
"filename": "Notepad++.vmdk",
"enabled": true,
"writable": "boolean",
"datastore_name": "datastore1",
"files_count": 2,
"total_use_count": 5,
"provision_uuid": "string",
"provisioning": "boolean",
"provision_completed_at": "2021-08-17 10:32:32 +0530",
"provision_started_at": "2021-08-17 10:30:26 +0530",
"size_mb": 73,
"size_human": "83.00 MB",
"assignment_count": 1,
"volume_guid": "{4f949610-35c1-4e52-9f71-89d899150007}",
"snapvol_version_id": "integer",
"mount_prefix": "string",
"mounted_at": "2021-08-17 11:00:32 +0530",
"template_file_name": "[data.1] appvolumes/packages_templates/template.vmdk",
"template_version": "2.10.0.709",
"missing": "boolean",
"protected": true,
"agent_version": "4.5.0.922D",
"capture_version": "4.0",
"free_mb": "integer",
"total_mb": "integer",
"attachment_limit": 2,
"reachable": true,
"provision_duration": "2 minutes",
"primordial_os_id": 2,
"primordial_os_name": "Windows 10 (x64)"
}
],
"owner_guid": "5F02DE3B-BAB1-4FDB-8065-ABB8711013EF",
"status": "active",
"delete_status": "deleting",
"sync_status": "string",
"sync_message": "string",
"synced_at": "2021-12-03 13:10:13 -0800",
"synced_at_human": "Dec 03 2021",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"metadata_sync_at": "2021-12-03 15:10:14 -0800",
"metadata_sync_at_human": "Dec 03 2021",
"metadata_properties_updated_at": "2021-12-03 15:10:14 -0800",
"metadata_properties_updated_at_human": "Dec 03 2021",
"metadata_version": "string"
}
]
}
{
"data": [
{
"id": "integer",
"name": "New",
"priority": "integer",
"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"
}
]
}
{
"data": [
{
"id": "integer",
"description": "This package is on its latest version 7.0.1",
"app_product_id": "integer",
"app_product_name": "Notepad++",
"app_package_id": "integer",
"app_package_name": "Notepad-7.0.1",
"app_marker_id": "integer",
"app_marker_name": "CURRENT",
"priority": "integer",
"mount_prefix": "string",
"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",
"entities": [
{
"id": 1,
"entity_type": "User",
"name": "testuser-1",
"account_name": "testuser-1",
"upn": "SNAPVOLUMES\\testuser-1",
"distinguished_name": "CN=testuser-1,OU=Domain Users,DC=Snapvolumes,DC=com"
}
],
"filters": [
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
]
}
{
"errors": [
{
"title": "Incorrect Package id 0 passed",
"meta": {
"manager": {
"title": "Incorrect Package id 0 passed"
}
}
}
]
}
errors
{
"data": [
{
"id": "integer",
"name": "Office 16",
"publisher": "Microsoft Corporation",
"install_location": "string",
"version": "16.0.10358.20061",
"icon": "/snapvols/19/Office_16.png",
"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",
"app_package_id": "integer"
}
]
}
{
"data": {
"id": "integer",
"name": "Notepad-7.0.1",
"guid": "14848eb3-169b-4e8a-bcb7-556f1811c08c",
"app_product_id": 3,
"lifecycle_stage_id": 1,
"state": "Package",
"version": "7.0.1",
"description": "This package is on its latest version 7.0.1",
"note": "The Package is best suited for development and HR dept.",
"display_delivery": "Classic",
"delivery": "classic",
"capable_of_on_demand": true,
"status": "enabled",
"programs_count": 2,
"icon": "/snapvols/9/Notepad++.7.0.1.png",
"operating_systems_count": "integer",
"delete_status": "deleting",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"added_at": "2021-12-03 13:10:13 -0800",
"added_at_human": "Dec 04 2021",
"attachment_count": 2,
"type": "AppPackage",
"format": "AV",
"path": "appvolumes/packages",
"filename": "Notepad++.vmdk",
"enabled": true,
"writable": "boolean",
"datastore_name": "datastore1",
"files_count": 2,
"total_use_count": 5,
"provision_uuid": "string",
"provisioning": "boolean",
"provision_completed_at": "2021-08-17 10:32:32 +0530",
"provision_started_at": "2021-08-17 10:30:26 +0530",
"size_mb": 73,
"size_human": "83.00 MB",
"assignment_count": 1,
"volume_guid": "{4f949610-35c1-4e52-9f71-89d899150007}",
"snapvol_version_id": "integer",
"mount_prefix": "string",
"mounted_at": "2021-08-17 11:00:32 +0530",
"template_file_name": "[data.1] appvolumes/packages_templates/template.vmdk",
"template_version": "2.10.0.709",
"missing": "boolean",
"protected": true,
"agent_version": "4.5.0.922D",
"capture_version": "4.0",
"free_mb": "integer",
"total_mb": "integer",
"attachment_limit": 2,
"reachable": true,
"provision_duration": "2 minutes",
"primordial_os_id": 2,
"primordial_os_name": "Windows 10 (x64)"
}
}
{
"data": [
{
"id": "integer",
"name": "Notepad-7.0.1",
"guid": "14848eb3-169b-4e8a-bcb7-556f1811c08c",
"app_product_id": 3,
"lifecycle_stage_id": 1,
"state": "Package",
"version": "7.0.1",
"description": "This package is on its latest version 7.0.1",
"note": "The Package is best suited for development and HR dept.",
"display_delivery": "Classic",
"delivery": "classic",
"capable_of_on_demand": true,
"status": "enabled",
"programs_count": 2,
"icon": "/snapvols/9/Notepad++.7.0.1.png",
"operating_systems_count": "integer",
"delete_status": "deleting",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"added_at": "2021-12-03 13:10:13 -0800",
"added_at_human": "Dec 04 2021",
"attachment_count": 2,
"type": "AppPackage",
"format": "AV",
"path": "appvolumes/packages",
"filename": "Notepad++.vmdk",
"enabled": true,
"writable": "boolean",
"datastore_name": "datastore1",
"files_count": 2,
"total_use_count": 5,
"provision_uuid": "string",
"provisioning": "boolean",
"provision_completed_at": "2021-08-17 10:32:32 +0530",
"provision_started_at": "2021-08-17 10:30:26 +0530",
"size_mb": 73,
"size_human": "83.00 MB",
"assignment_count": 1,
"volume_guid": "{4f949610-35c1-4e52-9f71-89d899150007}",
"snapvol_version_id": "integer",
"mount_prefix": "string",
"mounted_at": "2021-08-17 11:00:32 +0530",
"template_file_name": "[data.1] appvolumes/packages_templates/template.vmdk",
"template_version": "2.10.0.709",
"missing": "boolean",
"protected": true,
"agent_version": "4.5.0.922D",
"capture_version": "4.0",
"free_mb": "integer",
"total_mb": "integer",
"attachment_limit": 2,
"reachable": true,
"provision_duration": "2 minutes",
"primordial_os_id": 2,
"primordial_os_name": "Windows 10 (x64)"
}
]
}
{
"writable": {
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
}
{
"data": [
{
"id": "integer",
"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": "integer",
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"percent_available": "Unknown",
"template_version": "4.0.0",
"version_count": "integer",
"type": "DataDisk",
"display_type": "Writable Volume",
"error_action": "string",
"busy": "boolean",
"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": "integer",
"critical": "integer"
}
}
counts
{
"size_mb": 20480,
"volumes": [
"integer"
]
}
Requested size for the Writable Volume(s) in MB used during expansion operations.
IDs of Writable Volumes to increase size for.
{
"id": 1,
"type": "app_packages",
"attributes": {
"name": "Notepad++ 7.2.0",
"guid": "b9421adb-d6cb-47f0-81ba-10718d3a8611",
"app_product_id": 1,
"state": "Package",
"version": "7.2.0",
"programs_count": 1,
"operating_systems_count": 1,
"description": "string"
}
}
ID of relationship included.
The name of relationship included.
The attributes present in relationship object.
Detailed definition of relationships included in app-assignments.
[
{
"id": 1,
"type": "app_packages",
"attributes": {
"name": "Notepad++ 7.2.0",
"guid": "b9421adb-d6cb-47f0-81ba-10718d3a8611",
"app_product_id": 1,
"state": "Package",
"version": "7.2.0",
"programs_count": 1,
"operating_systems_count": 1,
"description": "string"
}
}
]
{
"id": "integer",
"name": "New",
"priority": "integer",
"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"
}
The LifecycleStage ID.
The Lifecycle Stage name.
Priority of the stage.
A collection of LifecycleStages.
[
{
"id": "integer",
"name": "New",
"priority": "integer",
"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"
}
]
The models available to fetch relationships of app assignments
Operating system record.
{
"id": "integer",
"name": "Windows 8.1 (x64)"
}
ID of the operating system.
Name of the operating system.
{
"id": "integer",
"description": "This package is on its latest version 7.0.1",
"app_product_id": "integer",
"app_product_name": "Notepad++",
"app_package_id": "integer",
"app_package_name": "Notepad-7.0.1",
"app_marker_id": "integer",
"app_marker_name": "CURRENT",
"priority": "integer",
"mount_prefix": "string",
"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",
"entities": [
{
"id": 1,
"entity_type": "User",
"name": "testuser-1",
"account_name": "testuser-1",
"upn": "SNAPVOLUMES\\testuser-1",
"distinguished_name": "CN=testuser-1,OU=Domain Users,DC=Snapvolumes,DC=com"
}
],
"filters": [
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
The Package Assignment ID.
The description of Package.
The Application ID to which Package belongs.
The Application name to which Package belongs.
The Package ID.
The Package name.
The Marker ID.
The Marker name.
Priority of Application assignment.
Mount prefix for the assignment.
A collection of Package Assignments.
[
{
"id": "integer",
"description": "This package is on its latest version 7.0.1",
"app_product_id": "integer",
"app_product_name": "Notepad++",
"app_package_id": "integer",
"app_package_name": "Notepad-7.0.1",
"app_marker_id": "integer",
"app_marker_name": "CURRENT",
"priority": "integer",
"mount_prefix": "string",
"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",
"entities": [
{
"id": 1,
"entity_type": "User",
"name": "testuser-1",
"account_name": "testuser-1",
"upn": "SNAPVOLUMES\\testuser-1",
"distinguished_name": "CN=testuser-1,OU=Domain Users,DC=Snapvolumes,DC=com"
}
],
"filters": [
{
"id": 3,
"type": "ComputerPrefixFilter",
"value": "COMP"
}
]
}
]
{
"id": "integer",
"name": "Notepad-7.0.1",
"guid": "14848eb3-169b-4e8a-bcb7-556f1811c08c",
"app_product_id": 3,
"lifecycle_stage_id": 1,
"state": "Package",
"version": "7.0.1",
"description": "This package is on its latest version 7.0.1",
"note": "The Package is best suited for development and HR dept.",
"display_delivery": "Classic",
"delivery": "classic",
"capable_of_on_demand": true,
"status": "enabled",
"programs_count": 2,
"icon": "/snapvols/9/Notepad++.7.0.1.png",
"operating_systems_count": "integer",
"delete_status": "deleting",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"added_at": "2021-12-03 13:10:13 -0800",
"added_at_human": "Dec 04 2021",
"attachment_count": 2,
"type": "AppPackage",
"format": "AV",
"path": "appvolumes/packages",
"filename": "Notepad++.vmdk",
"enabled": true,
"writable": "boolean",
"datastore_name": "datastore1",
"files_count": 2,
"total_use_count": 5,
"provision_uuid": "string",
"provisioning": "boolean",
"provision_completed_at": "2021-08-17 10:32:32 +0530",
"provision_started_at": "2021-08-17 10:30:26 +0530",
"size_mb": 73,
"size_human": "83.00 MB",
"assignment_count": 1,
"volume_guid": "{4f949610-35c1-4e52-9f71-89d899150007}",
"snapvol_version_id": "integer",
"mount_prefix": "string",
"mounted_at": "2021-08-17 11:00:32 +0530",
"template_file_name": "[data.1] appvolumes/packages_templates/template.vmdk",
"template_version": "2.10.0.709",
"missing": "boolean",
"protected": true,
"agent_version": "4.5.0.922D",
"capture_version": "4.0",
"free_mb": "integer",
"total_mb": "integer",
"attachment_limit": 2,
"reachable": true,
"provision_duration": "2 minutes",
"primordial_os_id": 2,
"primordial_os_name": "Windows 10 (x64)"
}
The Package ID.
The Package name.
The Package guid.
The Application ID to which Package belongs.
The lifecycle_stage_id of Package.
The current state of Package.
The version of Package.
The description of Package.
The note for Package
The delivery mode visible to end-user which is selected for Package.
The delivery mode selected for Package.
The capability status of delivery mode selected for Package.
The status for Package.
The number of Programs inside a Package.
The Package icon path.
The number of operating systems for Package.
The delete status of Package.
The attachment count for Package.
Type of Package.
Format of Package.
The path at which Package volume resides in datastore.
The filename for Package.
Package volume is enabled or not.
Package volume is a writable or not.
The datastore name where Package volume resides.
The number of files present for Package.
The number of times Package was used.
The Package provision_uuid.
Package is provisioning or not.
size in mb used by Package volume.
human readable format of size used by Package volume in mb.
The number of assignments made to Package.
The guid of Package Volume.
The snapvol_version_id for Package Volume.
Mount prefix for the assignment.
The template file name of the Package.
The Package template version.
Package Volume is available in datastore or not.
Package volume is protected or not.
The agent version used for Packaging of Package.
The capture version used for Packaging of Package.
Actual free space on the Package Volume.
Actual total space on the Package Volume - can differ from size_mb due to datastore file formatting and expansion operations.
The maximum attachment limit for Package.
Package volume is reachable or not.
The time taken by provisioning of Package.
ID of the base operating system.
Name of the base operating system.
Package ID.
Timestamp of the most recent Package mount.
{
"id": "integer",
"name": "Office 16",
"publisher": "Microsoft Corporation",
"install_location": "string",
"version": "16.0.10358.20061",
"icon": "/snapvols/19/Office_16.png",
"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",
"app_package_id": "integer"
}
The Program ID.
The Program name.
The Publisher name of the Program.
The install location of the Program.
The version of the Program.
The location at which icon picture resides.
The Package ID.
A collection of Package Programs.
[
{
"id": "integer",
"name": "Office 16",
"publisher": "Microsoft Corporation",
"install_location": "string",
"version": "16.0.10358.20061",
"icon": "/snapvols/19/Office_16.png",
"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",
"app_package_id": "integer"
}
]
A collection of Packages.
[
{
"id": "integer",
"name": "Notepad-7.0.1",
"guid": "14848eb3-169b-4e8a-bcb7-556f1811c08c",
"app_product_id": 3,
"lifecycle_stage_id": 1,
"state": "Package",
"version": "7.0.1",
"description": "This package is on its latest version 7.0.1",
"note": "The Package is best suited for development and HR dept.",
"display_delivery": "Classic",
"delivery": "classic",
"capable_of_on_demand": true,
"status": "enabled",
"programs_count": 2,
"icon": "/snapvols/9/Notepad++.7.0.1.png",
"operating_systems_count": "integer",
"delete_status": "deleting",
"deleted_at": "2021-12-04 13:10:13 -0800",
"deleted_at_human": "Dec 04 2021",
"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",
"added_at": "2021-12-03 13:10:13 -0800",
"added_at_human": "Dec 04 2021",
"attachment_count": 2,
"type": "AppPackage",
"format": "AV",
"path": "appvolumes/packages",
"filename": "Notepad++.vmdk",
"enabled": true,
"writable": "boolean",
"datastore_name": "datastore1",
"files_count": 2,
"total_use_count": 5,
"provision_uuid": "string",
"provisioning": "boolean",
"provision_completed_at": "2021-08-17 10:32:32 +0530",
"provision_started_at": "2021-08-17 10:30:26 +0530",
"size_mb": 73,
"size_human": "83.00 MB",
"assignment_count": 1,
"volume_guid": "{4f949610-35c1-4e52-9f71-89d899150007}",
"snapvol_version_id": "integer",
"mount_prefix": "string",
"mounted_at": "2021-08-17 11:00:32 +0530",
"template_file_name": "[data.1] appvolumes/packages_templates/template.vmdk",
"template_version": "2.10.0.709",
"missing": "boolean",
"protected": true,
"agent_version": "4.5.0.922D",
"capture_version": "4.0",
"free_mb": "integer",
"total_mb": "integer",
"attachment_limit": 2,
"reachable": true,
"provision_duration": "2 minutes",
"primordial_os_id": 2,
"primordial_os_name": "Windows 10 (x64)"
}
]
The Page number for which assignments are required
The size of Page (i.e. The number of records we want on one page)
{
"id": 1,
"type": "app_assignments",
"links": {
"self": "http://localhost:3000/app_volumes/app_assignments/1"
},
"attributes": {
"app_marker_id": "integer",
"app_product_id": "integer",
"app_package_id": "integer",
"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",
"delivery": "default"
},
"relationships": {
"app_product": {
"data": {
"type": "app_products",
"id": 1
}
},
"app_marker": {
"data": {
"type": "app_markers",
"id": 1
}
},
"app_package": {
"data": {
"type": "app_packages",
"id": 1
}
},
"app_assignment_entities": {
"data": [
{
"type": "app_assignment_entities",
"id": 1
}
]
},
"assignment_filters": {
"data": [
{
"type": "assignment_filters",
"id": 1
}
]
}
}
}
The Application Assignment ID.
The type of assignment.
links
attributes
relationships
A collection of app-assignments.
[
{
"id": 1,
"type": "app_assignments",
"links": {
"self": "http://localhost:3000/app_volumes/app_assignments/1"
},
"attributes": {
"app_marker_id": "integer",
"app_product_id": "integer",
"app_package_id": "integer",
"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",
"delivery": "default"
},
"relationships": {
"app_product": {
"data": {
"type": "app_products",
"id": 1
}
},
"app_marker": {
"data": {
"type": "app_markers",
"id": 1
}
},
"app_package": {
"data": {
"type": "app_packages",
"id": 1
}
},
"app_assignment_entities": {
"data": [
{
"type": "app_assignment_entities",
"id": 1
}
]
},
"assignment_filters": {
"data": [
{
"type": "assignment_filters",
"id": 1
}
]
}
}
}
]
Timestamp provisioning completed at.
Timestamp provisioning started at.
The extra models in order to fetch entity and filter details.
{
"error": "Server Error",
"detail": "Unexpected server error."
}
Server Error.
Details of error. Exact error format subject to change depending on type of error.
{
"error": "Session expired. Please login again."
}
Session expired. Create a session using and make the request with the _session_id cookie.
{
"data": {
"app_product_id": 1,
"lifecycle_stage_id": 1,
"lifecycle_stage_name": "Tested",
"app_product_guid": "654723bc-09de-4d9b-806c-9cd1d231a0ab",
"note": "The Package is best suited for development and HR dept.",
"name": "Notepad-7.0.1",
"description": "This package is on its latest version 7.0.1.",
"delivery": "classic"
}
}
data
{
"description": "Writable Volume for Administrator",
"error_action": "string",
"block_login": "integer",
"mount_prefix": "DESKTOP",
"oses": [
"integer"
]
}
Description for the Writable Volume.
Whether failures related to the Writable Volume will prevent application related attachments. Setting "continue_silently" will skip attachments and not alert the user. Setting "continue_alert" will alert the end user that the writable was not attached. Setting "disable_and_alert" will disable all virtualization and display an alert. Setting "disable_and_alert_on_error" will disable all virtualization and display an alert only for error cases (conflicts due to multiple logins are not considered an error). Must set as "" if a) owner_type is "Computer" or b) block_login parameter is set to "1".
Whether failures related to the Writable Volume will prevent User login.
Prefix used to determine whether the Writable Volume should mount to a particular Computer.
IDs of operating systems the Writable Volume is allowed to mount to.
Timestamp of last update.
Timestamp of last update in human readable format.
{
"version": "App Volumes 4, version 2206",
"internal": "4.7.0",
"copyright": "Copyright 2011-2022",
"configured": true,
"time_offset": 5,
"uptime": "less than a minute",
"database_uuid": "654723bc-09de-4d9b-806c-9cd1d231a0de"
}
The full product version of App Volumes Manager.
version
Product copyright year.
Tells if App Volumes Manager is configured or not.
The offset between the local timezone and UTC
The time since when App Volumes Manager service is running.
The database identifier.
Whether the Writable is busy with a current backup operation.
The number of computers where the Writable Volume is currently mounted.
Timestamp of when the Writable Volume was mounted.
Timestamp of when the Writable Volume was mounted in human readable format.
The current backup operation state if present.
{
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
id
Name of the Writable Volume.
HTML escaped name of the Writable Volume.
Alternative name derived from entity that owns the Writable Volume.
HTML escaped alternative name of the Writable Volume.
HTML hyperlink to owner entity in.
URL to owner entity HTML resource.
Owner ID of Writable Volume.
Owner name of the Writable Volume.
Entity type of the owner of the Writable Volume.
Down-level login name of owner of the Writable Volume.
HTML escaped down-level login name of owner of the Writable Volume.
Object-Guid of the Writable Volume owner.
Description text for the Writable Volume.
Machine that the Writable Volume is currently mounted to.
Whether the Writable Volume is currently attached.
Status of the Writable Volume.
Number of times Writable Volume has been updated.
Version tag for Writable Volume.
Whether failures related to the Writable Volume will prevent application related attachments and whether they alert the user. Must be blank if block_login=1.
Whether failures related to the Writable Volume will prevent User login.
Versioning status of Writable Volume.
The Writable Volume will mount only on computers whose name begins with the mount prefix.
Whether the Writable Volume was created with it's associated disk being created immediately or with background job.
Current total space in MB on the Writable Volume. This can differ from size_mb or requested_mb due to datastore file formatting and expansion operations.
Current free space in MB on the Writable Volume.
Current used space in MB of the Writable Volume.
Requested size of the Writable Volume in MB for expansion operations. Will be 'null' after expansion operations or if no request for expansion has been made. This can differ from total_mb due to datastore file formatting and expansion operations.
Version of Writable Template used to create the Writable Volume.
GUID assigned to the Writable Volume on the datastore.
Datastore the Writable Volume resides on.
Hypervisor host associated with the Writable Volume.
Type of hypervisor associated with the Writable Volume.
Path to the Writable Volume file.
Filename of the Writable Volume.
Formatted display of the Writable Volume's location.
Type of Writable Volume.
Display value of Writable Volume.
Number of Snapvol files present for Writable Volume.
File used to generate the Writable Volume.
Whether the Writable Volume is has delete protection set on datastore.
Percent of available space on Writable Volume.
Whether the Writable Volume is eligible for expansion operations.
Datastore host that the Writable Volume resides on.
ID of the base operating system.
Name of the base operating system.
List of operating systems compatible with the Writable Volume.
{
"not_found": [
{
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
],
"success": [
{
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
],
"error": [
{
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
],
"scheduled": [
{
"id": "integer",
"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": "integer",
"attached": "string",
"status": "enabled",
"version_count": "integer",
"version_tag": "0",
"error_action": "string",
"block_login": true,
"enable_version": "boolean",
"mount_prefix": "DESKTOP",
"defer_create": true,
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"template_version": "4.0.0",
"busy": "boolean",
"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": "integer",
"name": "Windows 8.1 (x64)"
}
]
}
]
}
Writable Volumes that were scheduled for deletion in background.
{
"id": "integer",
"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": "integer",
"total_mb": 10237,
"free_mb": 5237,
"size_mb": 5000,
"requested_mb": 20480,
"percent_available": "Unknown",
"template_version": "4.0.0",
"version_count": "integer",
"type": "DataDisk",
"display_type": "Writable Volume",
"error_action": "string",
"busy": "boolean",
"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
}
id
Name of the Writable Volume.
Alternative name derived from entity that owns the Writable Volume.
Owner ID of Writable Volume.
Owner of Writable Volume.
Entity type of the Writable Volume owner.
Down-level login name of the Writable Volume owner.
Object-Guid of the Writable Volume owner.
Whether the Writable Volume is currently attached.
Status of the Writable Volume.
Current total space in MB on the Writable Volume. This can differ from size_mb or requested_mb due to datastore file formatting and expansion operations.
Current free space in MB on the Writable Volume.
Current used space in MB on the Writable Volume.
Requested size of the Writable Volume in MB for expansion operations. Will be 'null' after expansion operations or if no request for expansion has been made. This can differ from total_mb due to datastore file formatting and expansion operations.
Percent of available space on the Writable Volume.
Version of Writable Template used to create the Writable Volume.
Number of times Writable Volume has been updated.
Type of Writable Volume.
Display value of Writable Volume.
Whether failures related to the Writable Volume will prevent application related attachments and whether they alert the user.
Filename of the Writable Volume.
Path to the Writable Volume file.
Datastore the Writable Volume resides on.
GUID assigned to the Writable Volume on the datastore.
Datastore host that the Writable Volume resides on.
Whether the Writable Volume is eligible for expansion operations.
Writable Volume ID.