Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Enter Maintenance Mode.
The ID of the target RAS Template.
Force stopping/updating of desktop VMs.
No Content
Unauthorized
Not Found
POST /api/VDI/Template/{id}/EnterMaintenance HTTP/1.1
Host:
Accept: */*
No content
Exit Maintenance Mode.
The ID of the target RAS Template.
Force stopping/updating of desktop VMs.
No Content
Unauthorized
Not Found
POST /api/VDI/Template/{id}/ExitMaintenance HTTP/1.1
Host:
Accept: */*
No content
Retrieve settings about RAS Templates.
The site ID from which to retrieve the RAS Template info (optional).
RAS Template name.
Success
Unauthorized
Not Found
GET /api/VDI/Template HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-07T02:34:58.309Z",
"timeLastMod": "2025-12-07T02:34:58.309Z",
"objType": [
"89 = AVDTemplate",
"101 = RDSTemplate",
"102 = VDITemplate"
],
"name": "text",
"siteId": 1,
"description": "text",
"providerId": 1,
"templateType": [
"0 = SingleSession",
"1 = MultiSession"
],
"vmId": "text",
"cloneMethod": [
"0 = FullClone",
"1 = LinkedClone"
],
"advanced": {
"folder": {
"folderName": "text",
"folderId": "text",
"subFolderName": "text"
},
"nativePool": {
"nativePoolId": "text",
"nativePoolName": "text",
"hwgpu": true
},
"physicalHost": {
"physicalHostId": "text",
"physicalHostName": "text"
},
"multipleNIC": {
"useSeperateNetworkInterface": true,
"address": "text",
"subnetMask": "text"
},
"aws": {
"instanceType": "text",
"storageDevices": [
{
"deviceName": "text",
"volumeType": [
"0 = gp2",
"1 = gp3",
"2 = io1",
"3 = io2",
"4 = standard"
],
"size": 1,
"maximumIOPS": 1,
"throughput": 1
}
]
},
"azure": {
"resourceGroup": "text",
"location": "text",
"vmSize": "text",
"osDiskType": [
"1 = StandardHDD",
"2 = StandardSSD",
"4 = PremiumSSD"
],
"virtualNetworkID": "text",
"virtualNetworkName": "text",
"subnet": {
"subnetID": "text",
"subnetName": "text"
}
}
},
"preparation": {
"imagePrepTool": [
"0 = SysPrep",
"1 = RASPrep"
],
"computerName": "text",
"ownerName": "text",
"organization": "text",
"administrator": "text",
"domain": "text",
"domainOrgUnit": "text"
},
"inheritDefaultOptimizationSettings": true,
"optimization": {
"enableOptimization": true,
"optimizationType": [
"0 = Automatic",
"1 = Manual"
],
"windowsDefenderATP": {
"winDefATPTurnOffOn": [
"0 = TurnOffWindowsDefenderATP",
"1 = TurnOnWindowsDefenderATP"
],
"disableRealTimeProtection": true,
"excludeFolders": [
"text"
],
"excludeProcesses": [
"text"
],
"excludeExtension": [
"text"
]
},
"windowsComponents": {
"windowsComponentsList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"componentName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsDefenderATPEnabled": true,
"windowsComponentsEnabled": true,
"windowsServicesEnabled": true,
"windowsScheduledTasksEnabled": true,
"windowsAdvancedOptionsEnabled": true,
"networkPerformanceEnabled": true,
"registryEnabled": true,
"visualEffectsEnabled": true,
"diskCleanupEnabled": true,
"customScriptEnabled": true,
"windowsServices": {
"windowsServicesList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"serviceName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsAdvancedOptions": {
"partialStartLayoutContent": "text",
"hibernate": true,
"teleCollection": true,
"systemRestore": true,
"additionalErrorReport": true,
"tiles": true,
"cortana": true,
"microsoftConsumerExperience": true,
"windowsTips": true,
"commonProgramGroups": true,
"partialStartMenu": true
},
"networkPerformance": {
"dirCacheMax": 1,
"dormantFileLimit": 1,
"fileNotFoundCache": 1,
"fileInfoCache": 1,
"fileInfoCacheEnable": true,
"directoryCacheEnable": true,
"fileNotFoundCacheEnable": true,
"dormantFileLimitEnable": true,
"disableTCP": true,
"disableIPv6CompEnable": true,
"disableIPv6ToIPv4": true,
"disableIsaTap": true
},
"customScript": {
"arguments": "text",
"command": "text",
"initDir": "text",
"user": "text"
},
"diskCleanup": {
"cleanupWinSxSFolder": true,
"cleanupSystemFiles": true,
"cleanupTemporaryFileLogs": true,
"removeOneDrive": true,
"deleteUserProfiles": true
},
"visualEffects": {
"visualEffectsTypes": [
"0 = LetWindowsChooseWhatsBest",
"1 = AdjustForBestAppearance",
"2 = AdjustForBestPerformance",
"3 = Custom"
],
"animateControlSelectElements": true,
"animateWindowsWhenMinimizingMaximizing": true,
"animateTaskbar": true,
"enablePeek": true,
"fadeSlideMenus": true,
"fadeSlideToolTips": true,
"fadeOutMenuItems": true,
"saveTaskbarThumbnail": true,
"showShadowUnderMouse": true,
"shadowUnderWindows": true,
"thumbnailsInsteadOfIcons": true,
"showTranslucentSelection": true,
"showWindowsContentWhilstDragging": true,
"slideOpenComboBoxes": true,
"smoothEdgesScreenFonts": true,
"smoothScrollListBoxes": true,
"dropShadowsIcon": true
},
"windowsScheduledTasks": {
"windowsScheduledTasksList": [
{
"task": "text",
"location": "text",
"type": [
"0 = Folder",
"1 = Task"
]
}
]
},
"registry": {
"registryList": [
{
"id": 1,
"action": [
"0 = Add",
"1 = Modify",
"2 = Delete"
],
"registryName": "text",
"dwordValue": 1,
"displayName": "text",
"hiveType": [
"0 = HKEY_CURRENT_CONFIG",
"1 = HKEY_USERS",
"2 = HKEY_LOCAL_MACHINE",
"3 = HKEY_CLASSES_ROOT"
],
"path": "text",
"regType": [
"0 = REG_SZ",
"1 = REG_DWORD",
"2 = REG_QWORD",
"3 = REG_MULTI_SZ",
"4 = REG_EXPAND_SZ"
],
"stringValue": "text"
}
]
},
"uwpApps": {
"allExcept": [
"text"
],
"followingPkgs": [
"text"
],
"removeType": [
"0 = AllExcept",
"1 = FollowingPkgs"
]
}
},
"licenseKeys": {
"licenseKeyType": [
"0 = KMS",
"1 = MAK"
],
"keys": [
{
"licenseKey": "text",
"keyLimit": 1
}
]
}
}
]Creates a new RAS Template.
The ID of a Provider on which the source desktop VM resides.
The ID of the source VM.
RAS Template Name.
The site ID in which to create the RAS Template info. If the parameter is omitted, the site ID of the Licensing Server will be used.
RAS Template Description.
Host Session Type
Clone Method
Folder name where desktop VMs will be created.
The ID of a folder where desktop VMs will be created.
Subfolder name where desktop VMs will be created.
The ID of the native pool where desktop VMs will be created.
The name of the native pool where desktop VMs will be created.
Enable hardware acceleration graphics licensing support.
The ID of a physical host where desktop VMs will be created.
The name of a physical host where desktop VMs will be created.
Use a separate network interface for LAN access.
The address of the network interface.
The subnet mask of the network interface.
Instance type.
Device name.
Volume type
Size (GiB).
Maximum IOPS.
Throughput (MB/s).
Resource group.
VM size.
Volume type
Virtual network ID.
Virtual network name.
Subnet ID.
Subnet name.
Image preparation tool
The FQDN or IP address of the target VM.
A desktop VM owner name (assigned to a VM by RASprep or Sysprep).
Organization name (assigned to a VM by RASprep or Sysprep).
Domain or WorkGroup to join (assigned to a VM by RASprep or Sysprep).
The password of the domain administrator specified in the Administrator parameter.
The administrator of the domain specified in the JoinDomain parameter.
The password of the administrator for the desktop VM (assigned to a VM by RASprep or Sysprep).
Domain Organization unit
Created
Unauthorized
Conflict
POST /api/VDI/Template HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 993
{
"providerId": 1,
"vmId": "text",
"name": "text",
"siteId": 1,
"description": "text",
"templateType": [
"0 = SingleSession",
"1 = MultiSession"
],
"cloneMethod": [
"0 = FullClone",
"1 = LinkedClone"
],
"folderName": "text",
"folderId": "text",
"subFolderName": "text",
"nativePoolId": "text",
"nativePoolName": "text",
"hwgpu": true,
"physicalHostId": "text",
"physicalHostName": "text",
"useSeperateNetworkInterface": true,
"address": "text",
"subnetMask": "text",
"instanceType": "text",
"deviceName": "text",
"volumeType": [
"0 = gp2",
"1 = gp3",
"2 = io1",
"3 = io2",
"4 = standard"
],
"size": 1,
"maximumIOPS": 1,
"throughput": 1,
"resourceGroup": "text",
"vmSize": "text",
"osDiskType": [
"1 = StandardHDD",
"2 = StandardSSD",
"4 = PremiumSSD"
],
"virtualNetworkID": "text",
"virtualNetworkName": "text",
"subnetID": "text",
"subnetName": "text",
"imagePrepTool": [
"0 = SysPrep",
"1 = RASPrep"
],
"computerName": "text",
"ownerName": "text",
"organization": "text",
"domain": "text",
"domainPassword": "text",
"administrator": "text",
"adminPassword": "text",
"domainOrgUnit": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-07T02:34:58.309Z",
"timeLastMod": "2025-12-07T02:34:58.309Z",
"objType": [
"89 = AVDTemplate",
"101 = RDSTemplate",
"102 = VDITemplate"
],
"name": "text",
"siteId": 1,
"description": "text",
"providerId": 1,
"templateType": [
"0 = SingleSession",
"1 = MultiSession"
],
"vmId": "text",
"cloneMethod": [
"0 = FullClone",
"1 = LinkedClone"
],
"advanced": {
"folder": {
"folderName": "text",
"folderId": "text",
"subFolderName": "text"
},
"nativePool": {
"nativePoolId": "text",
"nativePoolName": "text",
"hwgpu": true
},
"physicalHost": {
"physicalHostId": "text",
"physicalHostName": "text"
},
"multipleNIC": {
"useSeperateNetworkInterface": true,
"address": "text",
"subnetMask": "text"
},
"aws": {
"instanceType": "text",
"storageDevices": [
{
"deviceName": "text",
"volumeType": [
"0 = gp2",
"1 = gp3",
"2 = io1",
"3 = io2",
"4 = standard"
],
"size": 1,
"maximumIOPS": 1,
"throughput": 1
}
]
},
"azure": {
"resourceGroup": "text",
"location": "text",
"vmSize": "text",
"osDiskType": [
"1 = StandardHDD",
"2 = StandardSSD",
"4 = PremiumSSD"
],
"virtualNetworkID": "text",
"virtualNetworkName": "text",
"subnet": {
"subnetID": "text",
"subnetName": "text"
}
}
},
"preparation": {
"imagePrepTool": [
"0 = SysPrep",
"1 = RASPrep"
],
"computerName": "text",
"ownerName": "text",
"organization": "text",
"administrator": "text",
"domain": "text",
"domainOrgUnit": "text"
},
"inheritDefaultOptimizationSettings": true,
"optimization": {
"enableOptimization": true,
"optimizationType": [
"0 = Automatic",
"1 = Manual"
],
"windowsDefenderATP": {
"winDefATPTurnOffOn": [
"0 = TurnOffWindowsDefenderATP",
"1 = TurnOnWindowsDefenderATP"
],
"disableRealTimeProtection": true,
"excludeFolders": [
"text"
],
"excludeProcesses": [
"text"
],
"excludeExtension": [
"text"
]
},
"windowsComponents": {
"windowsComponentsList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"componentName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsDefenderATPEnabled": true,
"windowsComponentsEnabled": true,
"windowsServicesEnabled": true,
"windowsScheduledTasksEnabled": true,
"windowsAdvancedOptionsEnabled": true,
"networkPerformanceEnabled": true,
"registryEnabled": true,
"visualEffectsEnabled": true,
"diskCleanupEnabled": true,
"customScriptEnabled": true,
"windowsServices": {
"windowsServicesList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"serviceName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsAdvancedOptions": {
"partialStartLayoutContent": "text",
"hibernate": true,
"teleCollection": true,
"systemRestore": true,
"additionalErrorReport": true,
"tiles": true,
"cortana": true,
"microsoftConsumerExperience": true,
"windowsTips": true,
"commonProgramGroups": true,
"partialStartMenu": true
},
"networkPerformance": {
"dirCacheMax": 1,
"dormantFileLimit": 1,
"fileNotFoundCache": 1,
"fileInfoCache": 1,
"fileInfoCacheEnable": true,
"directoryCacheEnable": true,
"fileNotFoundCacheEnable": true,
"dormantFileLimitEnable": true,
"disableTCP": true,
"disableIPv6CompEnable": true,
"disableIPv6ToIPv4": true,
"disableIsaTap": true
},
"customScript": {
"arguments": "text",
"command": "text",
"initDir": "text",
"user": "text"
},
"diskCleanup": {
"cleanupWinSxSFolder": true,
"cleanupSystemFiles": true,
"cleanupTemporaryFileLogs": true,
"removeOneDrive": true,
"deleteUserProfiles": true
},
"visualEffects": {
"visualEffectsTypes": [
"0 = LetWindowsChooseWhatsBest",
"1 = AdjustForBestAppearance",
"2 = AdjustForBestPerformance",
"3 = Custom"
],
"animateControlSelectElements": true,
"animateWindowsWhenMinimizingMaximizing": true,
"animateTaskbar": true,
"enablePeek": true,
"fadeSlideMenus": true,
"fadeSlideToolTips": true,
"fadeOutMenuItems": true,
"saveTaskbarThumbnail": true,
"showShadowUnderMouse": true,
"shadowUnderWindows": true,
"thumbnailsInsteadOfIcons": true,
"showTranslucentSelection": true,
"showWindowsContentWhilstDragging": true,
"slideOpenComboBoxes": true,
"smoothEdgesScreenFonts": true,
"smoothScrollListBoxes": true,
"dropShadowsIcon": true
},
"windowsScheduledTasks": {
"windowsScheduledTasksList": [
{
"task": "text",
"location": "text",
"type": [
"0 = Folder",
"1 = Task"
]
}
]
},
"registry": {
"registryList": [
{
"id": 1,
"action": [
"0 = Add",
"1 = Modify",
"2 = Delete"
],
"registryName": "text",
"dwordValue": 1,
"displayName": "text",
"hiveType": [
"0 = HKEY_CURRENT_CONFIG",
"1 = HKEY_USERS",
"2 = HKEY_LOCAL_MACHINE",
"3 = HKEY_CLASSES_ROOT"
],
"path": "text",
"regType": [
"0 = REG_SZ",
"1 = REG_DWORD",
"2 = REG_QWORD",
"3 = REG_MULTI_SZ",
"4 = REG_EXPAND_SZ"
],
"stringValue": "text"
}
]
},
"uwpApps": {
"allExcept": [
"text"
],
"followingPkgs": [
"text"
],
"removeType": [
"0 = AllExcept",
"1 = FollowingPkgs"
]
}
},
"licenseKeys": {
"licenseKeyType": [
"0 = KMS",
"1 = MAK"
],
"keys": [
{
"licenseKey": "text",
"keyLimit": 1
}
]
}
}Retrieve settings of a RAS Template.
The ID of a RAS Template for which to retrieve the information.
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-07T02:34:58.309Z",
"timeLastMod": "2025-12-07T02:34:58.309Z",
"objType": [
"89 = AVDTemplate",
"101 = RDSTemplate",
"102 = VDITemplate"
],
"name": "text",
"siteId": 1,
"description": "text",
"providerId": 1,
"templateType": [
"0 = SingleSession",
"1 = MultiSession"
],
"vmId": "text",
"cloneMethod": [
"0 = FullClone",
"1 = LinkedClone"
],
"advanced": {
"folder": {
"folderName": "text",
"folderId": "text",
"subFolderName": "text"
},
"nativePool": {
"nativePoolId": "text",
"nativePoolName": "text",
"hwgpu": true
},
"physicalHost": {
"physicalHostId": "text",
"physicalHostName": "text"
},
"multipleNIC": {
"useSeperateNetworkInterface": true,
"address": "text",
"subnetMask": "text"
},
"aws": {
"instanceType": "text",
"storageDevices": [
{
"deviceName": "text",
"volumeType": [
"0 = gp2",
"1 = gp3",
"2 = io1",
"3 = io2",
"4 = standard"
],
"size": 1,
"maximumIOPS": 1,
"throughput": 1
}
]
},
"azure": {
"resourceGroup": "text",
"location": "text",
"vmSize": "text",
"osDiskType": [
"1 = StandardHDD",
"2 = StandardSSD",
"4 = PremiumSSD"
],
"virtualNetworkID": "text",
"virtualNetworkName": "text",
"subnet": {
"subnetID": "text",
"subnetName": "text"
}
}
},
"preparation": {
"imagePrepTool": [
"0 = SysPrep",
"1 = RASPrep"
],
"computerName": "text",
"ownerName": "text",
"organization": "text",
"administrator": "text",
"domain": "text",
"domainOrgUnit": "text"
},
"inheritDefaultOptimizationSettings": true,
"optimization": {
"enableOptimization": true,
"optimizationType": [
"0 = Automatic",
"1 = Manual"
],
"windowsDefenderATP": {
"winDefATPTurnOffOn": [
"0 = TurnOffWindowsDefenderATP",
"1 = TurnOnWindowsDefenderATP"
],
"disableRealTimeProtection": true,
"excludeFolders": [
"text"
],
"excludeProcesses": [
"text"
],
"excludeExtension": [
"text"
]
},
"windowsComponents": {
"windowsComponentsList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"componentName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsDefenderATPEnabled": true,
"windowsComponentsEnabled": true,
"windowsServicesEnabled": true,
"windowsScheduledTasksEnabled": true,
"windowsAdvancedOptionsEnabled": true,
"networkPerformanceEnabled": true,
"registryEnabled": true,
"visualEffectsEnabled": true,
"diskCleanupEnabled": true,
"customScriptEnabled": true,
"windowsServices": {
"windowsServicesList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"serviceName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsAdvancedOptions": {
"partialStartLayoutContent": "text",
"hibernate": true,
"teleCollection": true,
"systemRestore": true,
"additionalErrorReport": true,
"tiles": true,
"cortana": true,
"microsoftConsumerExperience": true,
"windowsTips": true,
"commonProgramGroups": true,
"partialStartMenu": true
},
"networkPerformance": {
"dirCacheMax": 1,
"dormantFileLimit": 1,
"fileNotFoundCache": 1,
"fileInfoCache": 1,
"fileInfoCacheEnable": true,
"directoryCacheEnable": true,
"fileNotFoundCacheEnable": true,
"dormantFileLimitEnable": true,
"disableTCP": true,
"disableIPv6CompEnable": true,
"disableIPv6ToIPv4": true,
"disableIsaTap": true
},
"customScript": {
"arguments": "text",
"command": "text",
"initDir": "text",
"user": "text"
},
"diskCleanup": {
"cleanupWinSxSFolder": true,
"cleanupSystemFiles": true,
"cleanupTemporaryFileLogs": true,
"removeOneDrive": true,
"deleteUserProfiles": true
},
"visualEffects": {
"visualEffectsTypes": [
"0 = LetWindowsChooseWhatsBest",
"1 = AdjustForBestAppearance",
"2 = AdjustForBestPerformance",
"3 = Custom"
],
"animateControlSelectElements": true,
"animateWindowsWhenMinimizingMaximizing": true,
"animateTaskbar": true,
"enablePeek": true,
"fadeSlideMenus": true,
"fadeSlideToolTips": true,
"fadeOutMenuItems": true,
"saveTaskbarThumbnail": true,
"showShadowUnderMouse": true,
"shadowUnderWindows": true,
"thumbnailsInsteadOfIcons": true,
"showTranslucentSelection": true,
"showWindowsContentWhilstDragging": true,
"slideOpenComboBoxes": true,
"smoothEdgesScreenFonts": true,
"smoothScrollListBoxes": true,
"dropShadowsIcon": true
},
"windowsScheduledTasks": {
"windowsScheduledTasksList": [
{
"task": "text",
"location": "text",
"type": [
"0 = Folder",
"1 = Task"
]
}
]
},
"registry": {
"registryList": [
{
"id": 1,
"action": [
"0 = Add",
"1 = Modify",
"2 = Delete"
],
"registryName": "text",
"dwordValue": 1,
"displayName": "text",
"hiveType": [
"0 = HKEY_CURRENT_CONFIG",
"1 = HKEY_USERS",
"2 = HKEY_LOCAL_MACHINE",
"3 = HKEY_CLASSES_ROOT"
],
"path": "text",
"regType": [
"0 = REG_SZ",
"1 = REG_DWORD",
"2 = REG_QWORD",
"3 = REG_MULTI_SZ",
"4 = REG_EXPAND_SZ"
],
"stringValue": "text"
}
]
},
"uwpApps": {
"allExcept": [
"text"
],
"followingPkgs": [
"text"
],
"removeType": [
"0 = AllExcept",
"1 = FollowingPkgs"
]
}
},
"licenseKeys": {
"licenseKeyType": [
"0 = KMS",
"1 = MAK"
],
"keys": [
{
"licenseKey": "text",
"keyLimit": 1
}
]
}
}Modifies the settings of a RAS Template.
The ID of a RAS Template to modify.
RAS Template Description.
Folder name where desktop VMs will be created.
The ID of a folder where desktop VMs will be created.
Subfolder name where desktop VMs will be created.
The ID of the native pool where desktop VMs will be created.
The name of the native pool where desktop VMs will be created.
Enable hardware acceleration graphics licensing support.
The ID of a physical host where desktop VMs will be created.
The name of a physical host where desktop VMs will be created.
Use a separate network interface for LAN access.
The address of the network interface.
The subnet mask of the network interface.
Instance type.
Device name.
Volume type
Size (GiB).
Maximum IOPS.
Throughput (MB/s).
Resource group.
VM size.
Volume type
Virtual network ID.
Virtual network name.
Subnet ID.
Subnet name.
Image preparation tool
The FQDN or IP address of the target VM.
A desktop VM owner name (assigned to a VM by RASprep or Sysprep).
Organization name (assigned to a VM by RASprep or Sysprep).
Domain or WorkGroup to join (assigned to a VM by RASprep or Sysprep).
The password of the domain administrator specified in the Administrator parameter.
The administrator of the domain specified in the JoinDomain parameter.
The password of the administrator for the desktop VM (assigned to a VM by RASprep or Sysprep).
Domain Organization unit
If true, default Optimization settings will be inherited.
No Content
Unauthorized
Not Found
PUT /api/VDI/Template/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 875
{
"description": "text",
"folderName": "text",
"folderId": "text",
"subFolderName": "text",
"nativePoolId": "text",
"nativePoolName": "text",
"hwgpu": true,
"physicalHostId": "text",
"physicalHostName": "text",
"useSeperateNetworkInterface": true,
"address": "text",
"subnetMask": "text",
"instanceType": "text",
"deviceName": "text",
"volumeType": [
"0 = gp2",
"1 = gp3",
"2 = io1",
"3 = io2",
"4 = standard"
],
"size": 1,
"maximumIOPS": 1,
"throughput": 1,
"resourceGroup": "text",
"vmSize": "text",
"osDiskType": [
"1 = StandardHDD",
"2 = StandardSSD",
"4 = PremiumSSD"
],
"virtualNetworkID": "text",
"virtualNetworkName": "text",
"subnetID": "text",
"subnetName": "text",
"imagePrepTool": [
"0 = SysPrep",
"1 = RASPrep"
],
"computerName": "text",
"ownerName": "text",
"organization": "text",
"domain": "text",
"domainPassword": "text",
"administrator": "text",
"adminPassword": "text",
"domainOrgUnit": "text",
"inheritDefaultOptimizationSettings": true
}No content
Remove settings of a RAS Template.
The ID of a RAS Template for which to retrieve the information.
No Content
Unauthorized
Not Found
DELETE /api/VDI/Template/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-07T02:34:58.309Z",
"timeLastMod": "2025-12-07T02:34:58.309Z",
"objType": [
"89 = AVDTemplate",
"101 = RDSTemplate",
"102 = VDITemplate"
],
"name": "text",
"siteId": 1,
"description": "text",
"providerId": 1,
"templateType": [
"0 = SingleSession",
"1 = MultiSession"
],
"vmId": "text",
"cloneMethod": [
"0 = FullClone",
"1 = LinkedClone"
],
"advanced": {
"folder": {
"folderName": "text",
"folderId": "text",
"subFolderName": "text"
},
"nativePool": {
"nativePoolId": "text",
"nativePoolName": "text",
"hwgpu": true
},
"physicalHost": {
"physicalHostId": "text",
"physicalHostName": "text"
},
"multipleNIC": {
"useSeperateNetworkInterface": true,
"address": "text",
"subnetMask": "text"
},
"aws": {
"instanceType": "text",
"storageDevices": [
{
"deviceName": "text",
"volumeType": [
"0 = gp2",
"1 = gp3",
"2 = io1",
"3 = io2",
"4 = standard"
],
"size": 1,
"maximumIOPS": 1,
"throughput": 1
}
]
},
"azure": {
"resourceGroup": "text",
"location": "text",
"vmSize": "text",
"osDiskType": [
"1 = StandardHDD",
"2 = StandardSSD",
"4 = PremiumSSD"
],
"virtualNetworkID": "text",
"virtualNetworkName": "text",
"subnet": {
"subnetID": "text",
"subnetName": "text"
}
}
},
"preparation": {
"imagePrepTool": [
"0 = SysPrep",
"1 = RASPrep"
],
"computerName": "text",
"ownerName": "text",
"organization": "text",
"administrator": "text",
"domain": "text",
"domainOrgUnit": "text"
},
"inheritDefaultOptimizationSettings": true,
"optimization": {
"enableOptimization": true,
"optimizationType": [
"0 = Automatic",
"1 = Manual"
],
"windowsDefenderATP": {
"winDefATPTurnOffOn": [
"0 = TurnOffWindowsDefenderATP",
"1 = TurnOnWindowsDefenderATP"
],
"disableRealTimeProtection": true,
"excludeFolders": [
"text"
],
"excludeProcesses": [
"text"
],
"excludeExtension": [
"text"
]
},
"windowsComponents": {
"windowsComponentsList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"componentName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsDefenderATPEnabled": true,
"windowsComponentsEnabled": true,
"windowsServicesEnabled": true,
"windowsScheduledTasksEnabled": true,
"windowsAdvancedOptionsEnabled": true,
"networkPerformanceEnabled": true,
"registryEnabled": true,
"visualEffectsEnabled": true,
"diskCleanupEnabled": true,
"customScriptEnabled": true,
"windowsServices": {
"windowsServicesList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"serviceName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsAdvancedOptions": {
"partialStartLayoutContent": "text",
"hibernate": true,
"teleCollection": true,
"systemRestore": true,
"additionalErrorReport": true,
"tiles": true,
"cortana": true,
"microsoftConsumerExperience": true,
"windowsTips": true,
"commonProgramGroups": true,
"partialStartMenu": true
},
"networkPerformance": {
"dirCacheMax": 1,
"dormantFileLimit": 1,
"fileNotFoundCache": 1,
"fileInfoCache": 1,
"fileInfoCacheEnable": true,
"directoryCacheEnable": true,
"fileNotFoundCacheEnable": true,
"dormantFileLimitEnable": true,
"disableTCP": true,
"disableIPv6CompEnable": true,
"disableIPv6ToIPv4": true,
"disableIsaTap": true
},
"customScript": {
"arguments": "text",
"command": "text",
"initDir": "text",
"user": "text"
},
"diskCleanup": {
"cleanupWinSxSFolder": true,
"cleanupSystemFiles": true,
"cleanupTemporaryFileLogs": true,
"removeOneDrive": true,
"deleteUserProfiles": true
},
"visualEffects": {
"visualEffectsTypes": [
"0 = LetWindowsChooseWhatsBest",
"1 = AdjustForBestAppearance",
"2 = AdjustForBestPerformance",
"3 = Custom"
],
"animateControlSelectElements": true,
"animateWindowsWhenMinimizingMaximizing": true,
"animateTaskbar": true,
"enablePeek": true,
"fadeSlideMenus": true,
"fadeSlideToolTips": true,
"fadeOutMenuItems": true,
"saveTaskbarThumbnail": true,
"showShadowUnderMouse": true,
"shadowUnderWindows": true,
"thumbnailsInsteadOfIcons": true,
"showTranslucentSelection": true,
"showWindowsContentWhilstDragging": true,
"slideOpenComboBoxes": true,
"smoothEdgesScreenFonts": true,
"smoothScrollListBoxes": true,
"dropShadowsIcon": true
},
"windowsScheduledTasks": {
"windowsScheduledTasksList": [
{
"task": "text",
"location": "text",
"type": [
"0 = Folder",
"1 = Task"
]
}
]
},
"registry": {
"registryList": [
{
"id": 1,
"action": [
"0 = Add",
"1 = Modify",
"2 = Delete"
],
"registryName": "text",
"dwordValue": 1,
"displayName": "text",
"hiveType": [
"0 = HKEY_CURRENT_CONFIG",
"1 = HKEY_USERS",
"2 = HKEY_LOCAL_MACHINE",
"3 = HKEY_CLASSES_ROOT"
],
"path": "text",
"regType": [
"0 = REG_SZ",
"1 = REG_DWORD",
"2 = REG_QWORD",
"3 = REG_MULTI_SZ",
"4 = REG_EXPAND_SZ"
],
"stringValue": "text"
}
]
},
"uwpApps": {
"allExcept": [
"text"
],
"followingPkgs": [
"text"
],
"removeType": [
"0 = AllExcept",
"1 = FollowingPkgs"
]
}
},
"licenseKeys": {
"licenseKeyType": [
"0 = KMS",
"1 = MAK"
],
"keys": [
{
"licenseKey": "text",
"keyLimit": 1
}
]
}
}Retrieves Registry.
The ID of the optimization setting to retrieve the registry.
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id}/Optimization/Registry HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"action": [
"0 = Add",
"1 = Modify",
"2 = Delete"
],
"registryName": "text",
"dwordValue": 1,
"displayName": "text",
"hiveType": [
"0 = HKEY_CURRENT_CONFIG",
"1 = HKEY_USERS",
"2 = HKEY_LOCAL_MACHINE",
"3 = HKEY_CLASSES_ROOT"
],
"path": "text",
"regType": [
"0 = REG_SZ",
"1 = REG_DWORD",
"2 = REG_QWORD",
"3 = REG_MULTI_SZ",
"4 = REG_EXPAND_SZ"
],
"stringValue": "text"
}
]Adds Registry to the optimization.
The ID of the optimization to retrieve the registry.
The action type for add registry entry
Name
Value
Display Name
The hive type for add registry entry
Path
The value type for add registry entry
String Value
Created
Unauthorized
Not Found
Conflict
POST /api/VDI/Template/{id}/Optimization/Registry HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 342
{
"action": [
"0 = Add",
"1 = Modify",
"2 = Delete"
],
"registryName": "text",
"dwordValue": 1,
"displayName": "text",
"hiveType": [
"0 = HKEY_CURRENT_CONFIG",
"1 = HKEY_USERS",
"2 = HKEY_LOCAL_MACHINE",
"3 = HKEY_CLASSES_ROOT"
],
"path": "text",
"regType": [
"0 = REG_SZ",
"1 = REG_DWORD",
"2 = REG_QWORD",
"3 = REG_MULTI_SZ",
"4 = REG_EXPAND_SZ"
],
"stringValue": "text"
}No content
Remove Registry Image Optimization Object.
Id Of the Optimization Settings to remove the registry object.
Registry Id
No Content
Unauthorized
Not Found
DELETE /api/VDI/Template/{id}/Optimization/Registry HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 16
{
"registryId": 1
}No content
Recreate All Desktops or a specific Desktop.
The ID of the target RAS Template.
The ID of a desktop VM to be recreated (optional).
No Content
Unauthorized
Not Found
POST /api/VDI/Template/{id}/RecreateDesktops HTTP/1.1
Host:
Accept: */*
No content
Retrieve a list of templates with status information.
Site ID for which the template with status information will be retrieved (optional)
Filter the result by name (optional)
Success
Unauthorized
Not Found
GET /api/VDI/Template/Status HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"siteId": 1,
"agentState": [
"0 = OK",
"1 = EnumSessionsFailed",
"2 = RDSRoleDisabled",
"3 = MaxNonCompletedSessions",
"4 = RASScheduleInProgress",
"5 = ConnectionFailed",
"6 = InvalidCredentials",
"7 = NeedsSysprep",
"8 = SysPrepInProgress",
"9 = CloningFailed",
"10 = Synchronising",
"13 = LogonDrainUntilRestart",
"14 = LogonDrain",
"15 = LogonDisabled",
"16 = ForcedDisconnect",
"17 = CloningCanceled",
"18 = RASprepInProgress",
"20 = InstallingRDSRole",
"21 = RebootPending",
"22 = PortMismatch",
"23 = NeedsDowngrade",
"24 = NotApplied",
"25 = CloningInProgress",
"26 = MarkedForDeletion",
"27 = StandBy",
"28 = UnsupportedVDIType",
"29 = FreeESXLicenseNotSupported",
"30 = ManagedESXNotSupported",
"32 = InvalidHostVersion",
"33 = NotJoined",
"35 = LicenseExpired",
"36 = JoinBroken",
"37 = InUse",
"38 = NotInUse",
"39 = Unsupported",
"40 = NoAvailableGateways",
"41 = EnrollServerNotInitialized",
"42 = EnrollmentUnavailable",
"43 = InvalidCAConfig",
"44 = InvalidEAUserCredentials",
"45 = InvalidESSettings",
"46 = FSLogixNotAvail",
"47 = NoDevices",
"48 = NeedsAttention",
"49 = ImageOptimizationPending",
"50 = ImageOptimization",
"51 = Unavailable",
"52 = UnderConstruction",
"53 = Broken",
"54 = NonRAS",
"55 = Provisioning",
"56 = Invalid",
"57 = FSLogixNeedsUpdate",
"58 = NoMembersAvailable",
"59 = MembersNeedUpdate",
"60 = FailedPerfCounters",
"61 = PendingRecreation",
"62 = RemovingMembers",
"63 = AddingMembers",
"64 = DeleteInProgress",
"66 = JoiningToHostPool",
"67 = AutoUpgradeInProgress",
"68 = AutoUpgradeInitiated",
"-8 = AutoUpgradeLimitReached",
"-7 = AutoUpgradeFailed",
"-6 = Unknown",
"-5 = NeedsUpdate",
"-4 = NotVerified",
"-3 = ServerDeleted",
"-2 = DisabledFromSettings",
"-1 = Disconnected"
],
"serverType": [
"1 = RDSHost",
"2 = Provider",
"3 = Gateway",
"4 = Guest",
"7 = PA",
"9 = Site",
"16 = RDSGroup",
"25 = HALBDevice",
"45 = TenantBroker",
"46 = Enrollment",
"51 = HALB",
"64 = AVDWorkspace",
"65 = AVDHostPool",
"66 = AVDTemplate",
"67 = AVDHost",
"95 = VDITemplateVersion",
"96 = AVDTemplateVersion",
"97 = RDSTemplateVersion",
"107 = RDSTemplate",
"108 = VDITemplate",
"2013 = VDIHost",
"-1 = All"
],
"name": "text",
"providerId": 1,
"desktopId": "text",
"status": [
"0 = Unknown",
"1 = CreatingVM",
"2 = CreateVMFailed",
"3 = PushingAgent",
"4 = PushAgentFailed",
"5 = Configuring",
"6 = ConfigureFailed",
"7 = Converting",
"8 = ConvertFailed",
"9 = Creating",
"10 = Created",
"11 = Deleting",
"12 = DeleteFailed",
"13 = Deleted",
"14 = Failed",
"15 = EnteringMaintenance",
"16 = ExitingMaintenance",
"17 = Maintenance",
"18 = CloningInProgress",
"19 = NeedsUpdate",
"20 = Broken",
"21 = CreatingVersion"
],
"powerState": [
"0 = Unknown",
"1 = PoweringOn",
"2 = PoweredOn",
"4 = PoweringOff",
"8 = PoweredOff",
"16 = Suspending",
"32 = Suspended",
"64 = FailedToCreate",
"512 = Sysprep",
"1024 = Cloning",
"2048 = Deleting",
"4096 = Rasprep",
"4097 = Connected",
"4098 = Disconnected"
],
"agentVer": "text",
"templateHasClones": true,
"agentStatus": [
"0 = OK",
"1 = EnumSessionsFailed",
"2 = RDSRoleDisabled",
"3 = MaxNonCompletedSessions",
"4 = RASScheduleInProgress",
"5 = ConnectionFailed",
"6 = InvalidCredentials",
"7 = NeedsSysprep",
"8 = SysPrepInProgress",
"9 = CloningFailed",
"10 = Synchronising",
"13 = LogonDrainUntilRestart",
"14 = LogonDrain",
"15 = LogonDisabled",
"16 = ForcedDisconnect",
"17 = CloningCanceled",
"18 = RASprepInProgress",
"20 = InstallingRDSRole",
"21 = RebootPending",
"22 = PortMismatch",
"23 = NeedsDowngrade",
"24 = NotApplied",
"25 = CloningInProgress",
"26 = MarkedForDeletion",
"27 = StandBy",
"28 = UnsupportedVDIType",
"29 = FreeESXLicenseNotSupported",
"30 = ManagedESXNotSupported",
"32 = InvalidHostVersion",
"33 = NotJoined",
"35 = LicenseExpired",
"36 = JoinBroken",
"37 = InUse",
"38 = NotInUse",
"39 = Unsupported",
"40 = NoAvailableGateways",
"41 = EnrollServerNotInitialized",
"42 = EnrollmentUnavailable",
"43 = InvalidCAConfig",
"44 = InvalidEAUserCredentials",
"45 = InvalidESSettings",
"46 = FSLogixNotAvail",
"47 = NoDevices",
"48 = NeedsAttention",
"49 = ImageOptimizationPending",
"50 = ImageOptimization",
"51 = Unavailable",
"52 = UnderConstruction",
"53 = Broken",
"54 = NonRAS",
"55 = Provisioning",
"56 = Invalid",
"57 = FSLogixNeedsUpdate",
"58 = NoMembersAvailable",
"59 = MembersNeedUpdate",
"60 = FailedPerfCounters",
"61 = PendingRecreation",
"62 = RemovingMembers",
"63 = AddingMembers",
"64 = DeleteInProgress",
"66 = JoiningToHostPool",
"67 = AutoUpgradeInProgress",
"68 = AutoUpgradeInitiated",
"-8 = AutoUpgradeLimitReached",
"-7 = AutoUpgradeFailed",
"-6 = Unknown",
"-5 = NeedsUpdate",
"-4 = NotVerified",
"-3 = ServerDeleted",
"-2 = DisabledFromSettings",
"-1 = Disconnected"
],
"distribution": [
"0 = Unknown",
"1 = Distributing",
"2 = DistributionFailed",
"4 = OK",
"8 = RemovingProvider",
"16 = NeedsMigration",
"32 = DeliveredFromSource",
"64 = ReceivedByTarget",
"128 = Deleting"
],
"templateVMExist": true
}
]Retrieve the template status information.
Template ID
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id}/Status HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"siteId": 1,
"agentState": [
"0 = OK",
"1 = EnumSessionsFailed",
"2 = RDSRoleDisabled",
"3 = MaxNonCompletedSessions",
"4 = RASScheduleInProgress",
"5 = ConnectionFailed",
"6 = InvalidCredentials",
"7 = NeedsSysprep",
"8 = SysPrepInProgress",
"9 = CloningFailed",
"10 = Synchronising",
"13 = LogonDrainUntilRestart",
"14 = LogonDrain",
"15 = LogonDisabled",
"16 = ForcedDisconnect",
"17 = CloningCanceled",
"18 = RASprepInProgress",
"20 = InstallingRDSRole",
"21 = RebootPending",
"22 = PortMismatch",
"23 = NeedsDowngrade",
"24 = NotApplied",
"25 = CloningInProgress",
"26 = MarkedForDeletion",
"27 = StandBy",
"28 = UnsupportedVDIType",
"29 = FreeESXLicenseNotSupported",
"30 = ManagedESXNotSupported",
"32 = InvalidHostVersion",
"33 = NotJoined",
"35 = LicenseExpired",
"36 = JoinBroken",
"37 = InUse",
"38 = NotInUse",
"39 = Unsupported",
"40 = NoAvailableGateways",
"41 = EnrollServerNotInitialized",
"42 = EnrollmentUnavailable",
"43 = InvalidCAConfig",
"44 = InvalidEAUserCredentials",
"45 = InvalidESSettings",
"46 = FSLogixNotAvail",
"47 = NoDevices",
"48 = NeedsAttention",
"49 = ImageOptimizationPending",
"50 = ImageOptimization",
"51 = Unavailable",
"52 = UnderConstruction",
"53 = Broken",
"54 = NonRAS",
"55 = Provisioning",
"56 = Invalid",
"57 = FSLogixNeedsUpdate",
"58 = NoMembersAvailable",
"59 = MembersNeedUpdate",
"60 = FailedPerfCounters",
"61 = PendingRecreation",
"62 = RemovingMembers",
"63 = AddingMembers",
"64 = DeleteInProgress",
"66 = JoiningToHostPool",
"67 = AutoUpgradeInProgress",
"68 = AutoUpgradeInitiated",
"-8 = AutoUpgradeLimitReached",
"-7 = AutoUpgradeFailed",
"-6 = Unknown",
"-5 = NeedsUpdate",
"-4 = NotVerified",
"-3 = ServerDeleted",
"-2 = DisabledFromSettings",
"-1 = Disconnected"
],
"serverType": [
"1 = RDSHost",
"2 = Provider",
"3 = Gateway",
"4 = Guest",
"7 = PA",
"9 = Site",
"16 = RDSGroup",
"25 = HALBDevice",
"45 = TenantBroker",
"46 = Enrollment",
"51 = HALB",
"64 = AVDWorkspace",
"65 = AVDHostPool",
"66 = AVDTemplate",
"67 = AVDHost",
"95 = VDITemplateVersion",
"96 = AVDTemplateVersion",
"97 = RDSTemplateVersion",
"107 = RDSTemplate",
"108 = VDITemplate",
"2013 = VDIHost",
"-1 = All"
],
"name": "text",
"providerId": 1,
"desktopId": "text",
"status": [
"0 = Unknown",
"1 = CreatingVM",
"2 = CreateVMFailed",
"3 = PushingAgent",
"4 = PushAgentFailed",
"5 = Configuring",
"6 = ConfigureFailed",
"7 = Converting",
"8 = ConvertFailed",
"9 = Creating",
"10 = Created",
"11 = Deleting",
"12 = DeleteFailed",
"13 = Deleted",
"14 = Failed",
"15 = EnteringMaintenance",
"16 = ExitingMaintenance",
"17 = Maintenance",
"18 = CloningInProgress",
"19 = NeedsUpdate",
"20 = Broken",
"21 = CreatingVersion"
],
"powerState": [
"0 = Unknown",
"1 = PoweringOn",
"2 = PoweredOn",
"4 = PoweringOff",
"8 = PoweredOff",
"16 = Suspending",
"32 = Suspended",
"64 = FailedToCreate",
"512 = Sysprep",
"1024 = Cloning",
"2048 = Deleting",
"4096 = Rasprep",
"4097 = Connected",
"4098 = Disconnected"
],
"agentVer": "text",
"templateHasClones": true,
"agentStatus": [
"0 = OK",
"1 = EnumSessionsFailed",
"2 = RDSRoleDisabled",
"3 = MaxNonCompletedSessions",
"4 = RASScheduleInProgress",
"5 = ConnectionFailed",
"6 = InvalidCredentials",
"7 = NeedsSysprep",
"8 = SysPrepInProgress",
"9 = CloningFailed",
"10 = Synchronising",
"13 = LogonDrainUntilRestart",
"14 = LogonDrain",
"15 = LogonDisabled",
"16 = ForcedDisconnect",
"17 = CloningCanceled",
"18 = RASprepInProgress",
"20 = InstallingRDSRole",
"21 = RebootPending",
"22 = PortMismatch",
"23 = NeedsDowngrade",
"24 = NotApplied",
"25 = CloningInProgress",
"26 = MarkedForDeletion",
"27 = StandBy",
"28 = UnsupportedVDIType",
"29 = FreeESXLicenseNotSupported",
"30 = ManagedESXNotSupported",
"32 = InvalidHostVersion",
"33 = NotJoined",
"35 = LicenseExpired",
"36 = JoinBroken",
"37 = InUse",
"38 = NotInUse",
"39 = Unsupported",
"40 = NoAvailableGateways",
"41 = EnrollServerNotInitialized",
"42 = EnrollmentUnavailable",
"43 = InvalidCAConfig",
"44 = InvalidEAUserCredentials",
"45 = InvalidESSettings",
"46 = FSLogixNotAvail",
"47 = NoDevices",
"48 = NeedsAttention",
"49 = ImageOptimizationPending",
"50 = ImageOptimization",
"51 = Unavailable",
"52 = UnderConstruction",
"53 = Broken",
"54 = NonRAS",
"55 = Provisioning",
"56 = Invalid",
"57 = FSLogixNeedsUpdate",
"58 = NoMembersAvailable",
"59 = MembersNeedUpdate",
"60 = FailedPerfCounters",
"61 = PendingRecreation",
"62 = RemovingMembers",
"63 = AddingMembers",
"64 = DeleteInProgress",
"66 = JoiningToHostPool",
"67 = AutoUpgradeInProgress",
"68 = AutoUpgradeInitiated",
"-8 = AutoUpgradeLimitReached",
"-7 = AutoUpgradeFailed",
"-6 = Unknown",
"-5 = NeedsUpdate",
"-4 = NotVerified",
"-3 = ServerDeleted",
"-2 = DisabledFromSettings",
"-1 = Disconnected"
],
"distribution": [
"0 = Unknown",
"1 = Distributing",
"2 = DistributionFailed",
"4 = OK",
"8 = RemovingProvider",
"16 = NeedsMigration",
"32 = DeliveredFromSource",
"64 = ReceivedByTarget",
"128 = Deleting"
],
"templateVMExist": true
}Retrieve a list of template's versions.
Site ID for which the template with version information will be retrieved (optional)
Filter the result by name (optional)
Success
Unauthorized
Not Found
GET /api/VDI/Template/Version HTTP/1.1
Host:
Accept: */*
[
{
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-07T02:34:58.309Z",
"timeLastMod": "2025-12-07T02:34:58.309Z",
"name": "text",
"id": 1,
"templateId": 1,
"description": "text"
}
]Retrieve a list of template's versions.
Template ID
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id}/Version HTTP/1.1
Host:
Accept: */*
[
{
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-07T02:34:58.309Z",
"timeLastMod": "2025-12-07T02:34:58.309Z",
"name": "text",
"id": 1,
"templateId": 1,
"description": "text"
}
]Modify properties of a RAS Template version.
The ID of a RAS Template
The ID of a RAS Template Version
Template version name.
Template version description
No Content
Unauthorized
Not Found
PUT /api/VDI/Template/{id}/Version/{VersionId} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 39
{
"newName": "text",
"description": "text"
}No content
Remove settings of a RAS Template version.
The ID of a RAS Template
The ID of a RAS Template Version
No Content
Unauthorized
Not Found
DELETE /api/VDI/Template/{id}/Version/{VersionId} HTTP/1.1
Host:
Accept: */*
{
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-07T02:34:58.309Z",
"timeLastMod": "2025-12-07T02:34:58.309Z",
"name": "text",
"id": 1,
"templateId": 1,
"description": "text"
}Retrieve Windows Component Custom
The ID of the optimization setting to retrieve the windows component custom list.
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id}/Optimization/WindowsComponent HTTP/1.1
Host:
Accept: */*
[
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"componentName": "text",
"displayName": "text",
"aliases": "text"
}
]Adds a Windows Component Custom to optimization.
The ID of the Optimization settings to add the windows component custom.
Windows Components Alias
Windows Components Diplay Name
Windows Components Name
Created
Unauthorized
Not Found
Conflict
POST /api/VDI/Template/{id}/Optimization/WindowsComponent HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 62
{
"aliases": "text",
"displayName": "text",
"componentName": "text"
}No content
Removes Windows Component Custom From Optimization.
The ID of the optimization setting to remove the windows component custom.
Windows Component Name
No Content
Unauthorized
Not Found
DELETE /api/VDI/Template/{id}/Optimization/WindowsComponent HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 24
{
"componentName": "text"
}No content
Retrieve Windows Scheduled Task
The ID of the optimization setting to retrieve the windows scheduled task.
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id}/Optimization/WindowsScheduledTask HTTP/1.1
Host:
Accept: */*
[
{
"task": "text",
"location": "text",
"type": [
"0 = Folder",
"1 = Task"
]
}
]Adds a Windows Scheduled task to optimization.
The ID of the Optimization settings to retrieve the windows scheduled task.
Scheduled Task Name
Scheduled Task Location
Created
Unauthorized
Not Found
Conflict
POST /api/VDI/Template/{id}/Optimization/WindowsScheduledTask HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33
{
"task": "text",
"location": "text"
}No content
Removes Windows Scheduled Task From Optimization.
The ID of the optimization setting to remove the windows scheduled task.
Scheduled Task
Scheduled Task Location
No Content
Unauthorized
Not Found
DELETE /api/VDI/Template/{id}/Optimization/WindowsScheduledTask HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33
{
"task": "text",
"location": "text"
}No content
Retrieve Windows Service Custom
The ID of the optimization setting to retrieve the windows service custom list.
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id}/Optimization/WindowsService HTTP/1.1
Host:
Accept: */*
[
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"serviceName": "text",
"displayName": "text",
"aliases": "text"
}
]Adds a Windows Service Custom to optimization.
The ID of the Optimization settings to add the windows services custom.
Windows Services Alias
Windows Services Diplay Name
Windows Service Name
Created
Unauthorized
Not Found
Conflict
POST /api/VDI/Template/{id}/Optimization/WindowsService HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 60
{
"aliases": "text",
"displayName": "text",
"serviceName": "text"
}No content
Removes Windows Service Custom From Optimization.
The ID of the optimization setting to remove the windows Service custom.
Windows Service Name
No Content
Unauthorized
Not Found
DELETE /api/VDI/Template/{id}/Optimization/WindowsService HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22
{
"serviceName": "text"
}No content
Retrieve a status of a template version.
Template Version ID
Success
Unauthorized
Not Found
GET /api/VDI/Template/VersionStatus/{VersionId} HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"agentVersion": "text",
"parentID": 1,
"status": [
"0 = NotCreated",
"1 = Creating",
"2 = OK",
"3 = FailedToCreate",
"4 = Deleting",
"5 = DeletionPending",
"6 = DeletingClones",
"-1 = Unknown"
],
"templateID": 1,
"versionType": 1
}
]Retrieve a list of a template's version statuses.
Template ID
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id}/VersionStatus HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"agentVersion": "text",
"parentID": 1,
"status": [
"0 = NotCreated",
"1 = Creating",
"2 = OK",
"3 = FailedToCreate",
"4 = Deleting",
"5 = DeletionPending",
"6 = DeletingClones",
"-1 = Unknown"
],
"templateID": 1,
"versionType": 1
}
]Retrieve the list RAS Template license keys.
The ID of a RAS Template to obtain information from.
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id}/LicenseKey HTTP/1.1
Host:
Accept: */*
{
"licenseKeyType": [
"0 = KMS",
"1 = MAK"
],
"keys": [
{
"licenseKey": "text",
"keyLimit": 1
}
]
}Modify properties of a RAS Template license key.
The ID of a RAS Template to modify.
Add a license key to the Template license keys list
The license key.
The max limit for the license key.
Created
Unauthorized
Not Found
POST /api/VDI/Template/{id}/LicenseKey HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 27
{
"key": "text",
"keyLimit": 1
}No content
Delete the specified license key info from the specified RAS Template configuration.
The ID of the RAS Template to remove license key from.
Remove a license key from the Template license keys list
The license key to remove.
No Content
Unauthorized
Not Found
DELETE /api/VDI/Template/{id}/LicenseKey HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 14
{
"key": "text"
}No content
Retrieve Image Optimization Settings
Retrieve the Image Optimization by id
Success
Unauthorized
Not Found
GET /api/VDI/Template/{id}/Optimization HTTP/1.1
Host:
Accept: */*
{
"enableOptimization": true,
"optimizationType": [
"0 = Automatic",
"1 = Manual"
],
"windowsDefenderATP": {
"winDefATPTurnOffOn": [
"0 = TurnOffWindowsDefenderATP",
"1 = TurnOnWindowsDefenderATP"
],
"disableRealTimeProtection": true,
"excludeFolders": [
"text"
],
"excludeProcesses": [
"text"
],
"excludeExtension": [
"text"
]
},
"windowsComponents": {
"windowsComponentsList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"componentName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsDefenderATPEnabled": true,
"windowsComponentsEnabled": true,
"windowsServicesEnabled": true,
"windowsScheduledTasksEnabled": true,
"windowsAdvancedOptionsEnabled": true,
"networkPerformanceEnabled": true,
"registryEnabled": true,
"visualEffectsEnabled": true,
"diskCleanupEnabled": true,
"customScriptEnabled": true,
"windowsServices": {
"windowsServicesList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"serviceName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsAdvancedOptions": {
"partialStartLayoutContent": "text",
"hibernate": true,
"teleCollection": true,
"systemRestore": true,
"additionalErrorReport": true,
"tiles": true,
"cortana": true,
"microsoftConsumerExperience": true,
"windowsTips": true,
"commonProgramGroups": true,
"partialStartMenu": true
},
"networkPerformance": {
"dirCacheMax": 1,
"dormantFileLimit": 1,
"fileNotFoundCache": 1,
"fileInfoCache": 1,
"fileInfoCacheEnable": true,
"directoryCacheEnable": true,
"fileNotFoundCacheEnable": true,
"dormantFileLimitEnable": true,
"disableTCP": true,
"disableIPv6CompEnable": true,
"disableIPv6ToIPv4": true,
"disableIsaTap": true
},
"customScript": {
"arguments": "text",
"command": "text",
"initDir": "text",
"user": "text"
},
"diskCleanup": {
"cleanupWinSxSFolder": true,
"cleanupSystemFiles": true,
"cleanupTemporaryFileLogs": true,
"removeOneDrive": true,
"deleteUserProfiles": true
},
"visualEffects": {
"visualEffectsTypes": [
"0 = LetWindowsChooseWhatsBest",
"1 = AdjustForBestAppearance",
"2 = AdjustForBestPerformance",
"3 = Custom"
],
"animateControlSelectElements": true,
"animateWindowsWhenMinimizingMaximizing": true,
"animateTaskbar": true,
"enablePeek": true,
"fadeSlideMenus": true,
"fadeSlideToolTips": true,
"fadeOutMenuItems": true,
"saveTaskbarThumbnail": true,
"showShadowUnderMouse": true,
"shadowUnderWindows": true,
"thumbnailsInsteadOfIcons": true,
"showTranslucentSelection": true,
"showWindowsContentWhilstDragging": true,
"slideOpenComboBoxes": true,
"smoothEdgesScreenFonts": true,
"smoothScrollListBoxes": true,
"dropShadowsIcon": true
},
"windowsScheduledTasks": {
"windowsScheduledTasksList": [
{
"task": "text",
"location": "text",
"type": [
"0 = Folder",
"1 = Task"
]
}
]
},
"registry": {
"registryList": [
{
"id": 1,
"action": [
"0 = Add",
"1 = Modify",
"2 = Delete"
],
"registryName": "text",
"dwordValue": 1,
"displayName": "text",
"hiveType": [
"0 = HKEY_CURRENT_CONFIG",
"1 = HKEY_USERS",
"2 = HKEY_LOCAL_MACHINE",
"3 = HKEY_CLASSES_ROOT"
],
"path": "text",
"regType": [
"0 = REG_SZ",
"1 = REG_DWORD",
"2 = REG_QWORD",
"3 = REG_MULTI_SZ",
"4 = REG_EXPAND_SZ"
],
"stringValue": "text"
}
]
},
"uwpApps": {
"allExcept": [
"text"
],
"followingPkgs": [
"text"
],
"removeType": [
"0 = AllExcept",
"1 = FollowingPkgs"
]
}
}Update the Image Optimization settings with the specified ID.
The ID for which to modify the Image Optimization.
Whether Optimization is Enabled or not
Optimization Type
Whether Windows Defender ATP is enabled or not
Whether Windows Components is enabled or not
Whether Windows Services is enabled or not
Whether Windows Scheduled Task is enabled or not
Whether Windows Advanced Options is enabled or not
Whether Network Performance is enabled or not
Whether Registry is enabled or not
Whether Visual Effects is enabled or not
Whether Disk Cleanup is enabled or not
Whether Custom Script is enabled or not
Windows enable options
Disable Real Time Protection
Exclude Folders List
Exclude Processes
Exclude Extensions
Partial Start menu layout
Whether Hibernate is enabled or not
Whether TeleCollection is enabled or not
Whether System Restore is enabled or not
Whether Additional Error Reporting is enabled or not
Whether Tiles is enabled or not
Whether Cortana is enabled or not
Whether Microsoft Consumer Experience is enabled or not
Whether Windows Tips is enabled or not
Whether Common Program Groups is enabled or not
Whether Partial Start Menu is enabled or not
Directory Cache Value
Dormant File Limit Value
File Not Found Cache Value
File Info Cache Value
Whether File Info Cache is enabled or not
Whether Directory Cache is enabled or not
Whether File Not Found Cache is enabled or not
Whether Dormant File Limit is enabled or not
Whether Disable TCP is enabled or not
Whether Disable IPv6 Components is enabled or not
Whether Disable IPv6 To IPv4 is enabled or not
Whether Disable IsaTap for IPv6 is enabled or not
Arguments
Command
Initial Directory
User
Password
Whether Clean up windows SxS Folder is enabled or not
Whether Clean up system files is enabled or not
Whether Clean up temporary file logs is enabled or not
Whether Remove One Drives is enabled or not
Whether Delete User Profiles is enabled or not
Visual Effects Type
Whether Animate Control Select Elements is enabled or not
Whether Animate Windows When Minimizing Or Maximizing is enabled or not
Whether Animate Taskbar is enabled or not
Whether Peek is enabled or not
Whether Fade Slide Menus is enabled or not
Whether Fade Slide Tool Tips is enabled or not
Whether Fade Out Menu Items is enabled or not
Whether Taskbar Thumbnail is enabled or not
Whether Shadow Under Mouse is enabled or not
Whether Shadow Under Windows is enabled or not
Whether Thumbnails instead of icons is enabled or not
Whether Translucent Selection is enabled or not
Whether Windows Content Whilst Dragging is enabled or not
Whether Slide open combo boxes is enabled or not
Whether Smooth Edges Screen Fonts is enabled or not
Whether Smooth Scroll List Boxes is enabled or not
Whether Drop Shadow Icon is enabled or not
Force Optimization.
falseNo Content
Unauthorized
Not Found
PUT /api/VDI/Template/{id}/Optimization HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1975
{
"enableOptimization": true,
"optimizationType": [
"0 = Automatic",
"1 = Manual"
],
"windowsDefenderATPEnabled": true,
"windowsComponentsEnabled": true,
"windowsServicesEnabled": true,
"windowsScheduledTasksEnabled": true,
"windowsAdvancedOptionsEnabled": true,
"networkPerformanceEnabled": true,
"registryEnabled": true,
"visualEffectsEnabled": true,
"diskCleanupEnabled": true,
"customScriptEnabled": true,
"winDefATPTurnOffOn": [
"0 = TurnOffWindowsDefenderATP",
"1 = TurnOnWindowsDefenderATP"
],
"disableRealTimeProtection": true,
"excludeFolders": [
"text"
],
"excludeProcesses": [
"text"
],
"excludeExtension": [
"text"
],
"partialStartLayoutContent": "text",
"hibernate": true,
"teleCollection": true,
"systemRestore": true,
"additionalErrorReport": true,
"tiles": true,
"cortana": true,
"microsoftConsumerExperience": true,
"windowsTips": true,
"commonProgramGroups": true,
"partialStartMenu": true,
"dirCacheMax": 1,
"dormantFileLimit": 1,
"fileNotFoundCache": 1,
"fileInfoCache": 1,
"fileInfoCacheEnable": true,
"directoryCacheEnable": true,
"fileNotFoundCacheEnable": true,
"dormantFileLimitEnable": true,
"disableTCP": true,
"disableIPv6CompEnable": true,
"disableIPv6ToIPv4": true,
"disableIsaTap": true,
"arguments": "text",
"command": "text",
"initDir": "text",
"user": "text",
"password": "text",
"cleanupWinSxSFolder": true,
"cleanupSystemFiles": true,
"cleanupTemporaryFileLogs": true,
"removeOneDrive": true,
"deleteUserProfiles": true,
"visualEffectsTypes": [
"0 = LetWindowsChooseWhatsBest",
"1 = AdjustForBestAppearance",
"2 = AdjustForBestPerformance",
"3 = Custom"
],
"animateControlSelectElements": true,
"animateWindowsWhenMinimizingMaximizing": true,
"animateTaskbar": true,
"enablePeek": true,
"fadeSlideMenus": true,
"fadeSlideToolTips": true,
"fadeOutMenuItems": true,
"saveTaskbarThumbnail": true,
"showShadowUnderMouse": true,
"shadowUnderWindows": true,
"thumbnailsInsteadOfIcons": true,
"showTranslucentSelection": true,
"showWindowsContentWhilstDragging": true,
"slideOpenComboBoxes": true,
"smoothEdgesScreenFonts": true,
"smoothScrollListBoxes": true,
"dropShadowsIcon": true,
"force": false
}No content