Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Create a new AVD Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
This is an Experimental feature which is subject to slight changes.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Create a new HyperV Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Created
Unauthorized
Conflict
Create a new Nutanix Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Created
Unauthorized
Conflict
Create a new RemotePCStatic Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Created
Unauthorized
Conflict
Retrieve information about one or multiple Schedule setting.
Site ID from which to retrieve the Schedule setting (optional).
The name of the Schedule setting for which to retrieve the information. This must be the actual Schedule setting name used in the RAS connections.
Success
Unauthorized
Not Found
Retrieve information about a particular Schedule setting by ID.
The ID of the Schedule setting for which to retrieve the information.
Success
Unauthorized
Not Found
Modify properties of a Schedule setting.
The ID of the Schedule setting to modify.
A new name for the scheduler job.
Whether to enable or disable the schedule.
Schedule description.
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
No Content
Unauthorized
Not Found
Retrieve Schedule Message(s).
The ID of the Schedule setting for which to retrieve the messages.
Success
Unauthorized
Not Found
Create a Schedule Message.
The ID of the Schedule setting for which to create the message.
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Created
Unauthorized
Not Found
Retrieve a Schedule Message.
The ID of the Schedule setting for which to retrieve the message.
The ID of the message to retrieve.
Success
Unauthorized
Not Found
Update a Schedule Message.
The ID of the Schedule setting for which to modify the message.
The ID of the message to modify.
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
No Content
Unauthorized
Not Found
No content
Delete a Schedule Message by ID.
The ID of the Schedule setting for which to remove the message.
The ID of the message to remove.
No Content
Unauthorized
Not Found
No content
Retrieve Schedule Message(s).
The ID of the Schedule setting for which to retrieve the messages.
Success
Unauthorized
Not Found
Create a Schedule Message.
The ID of the Schedule setting for which to create the message.
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Created
Unauthorized
Not Found
Retrieve a Schedule Message.
The ID of the Schedule setting for which to retrieve the message.
The ID of the message to retrieve.
Success
Unauthorized
Not Found
Update a Schedule Message.
The ID of the Schedule setting for which to modify the message.
The ID of the message to modify.
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
No Content
Unauthorized
Not Found
No content
Delete a Schedule Message by ID.
The ID of the Schedule setting for which to remove the message.
The ID of the message to remove.
No Content
Unauthorized
Not Found
No content
Creates a new disable Schedule.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
Unauthorized
Conflict
Retrieve a list of Host status by Site Id.
Site Id from which to retrieve the Host VM list (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Retrieve a list of Host status by Provider Id.
The Provider Id from which to retrieve the Hosts.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Retrieve the Host status.
The Provider Id from which to retrieve the Hosts.
The ID of the Host for which to retrieve the status.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Creates a new Reboot Schedule.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
Unauthorized
Conflict
Import a list of Remote PC Static to a Provider from a file.
Provider ID
Upload File
Created
Unauthorized
Conflict
No content
Create a new RemotePCDynamic Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Create provider of type AWSEC2
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
The preferred Connection Broker ID.
Use all guests.
AWSEC2 Hypervisor Type
The access key ID of the Amazon Web Service account.
The secret access key of the Amazon Web Service account.
Created
Unauthorized
Conflict
Create a new Azure Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Specifies the friendly name of the Provider.
Created
Unauthorized
Conflict
Create a new HyperV Failover Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Created
Unauthorized
Conflict
Retrieve the Remote PC Static list of a Provider.
Provider ID
Success
Unauthorized
Not Found
Add a Remote PC Static to a Provider.
Provider ID
Add a new Remote PC Static to a Provider
Remote PC Static Name.
Remote PC Static MAC Address.
Remote PC Static Subnet. Default: 0.0.0.0
Created
Unauthorized
Not Found
Conflict
No content
Update a Remote PC Static of a Provider.
Provider ID
Remote PC Static ID
Set a Remote PC Static within a Provider
Remote PC Static Name
Remote PC Static MAC Address
Remote PC Static Subnet
No Content
Unauthorized
Not Found
No content
Remove a Remote PC Static from a Provider.
Provider ID
Remote PC Static ID
No Content
Unauthorized
Not Found
No content
Retrieve a list of VM information.
Site ID for which to retrieve VM information (optional)
Success
Unauthorized
Not Found
Retrieve a list of VM information of a specific Provider by ID.
Provider ID
Success
Unauthorized
Not Found
Retrieve a specific VM by ID from a specific Provider by ID.
Provider ID
VM ID
Success
Unauthorized
Not Found
Creates a new Shutdown Schedule.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
Unauthorized
Conflict
Retrieve a list of Provider settings.
Site ID for which to retrieve Provider settings (optional)
Filter the result by Provider name (optional)
Success
Unauthorized
Not Found
Create a new Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Deprecated path - To create a new provider specify the type in the url ex: api/provider/hyperv
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Create a new Provider
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
The preferred Connection Broker ID.
Use all guests.
Created
Unauthorized
Conflict
Modify Provider server settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
Provider ID
Update an existing Provider settings
Enables or disables the specified Provider server in a site.
A new name for the Provider.
The name of the target Provider server. This must be the actual server name used in the RAS farm.
A user-defined Provider server description.
Specifies the Provider server direct address.
Specifies the port number for the RAS VDI Agent.
FQDN or IP address of the server where the RAS VDI Agent is running. You only need to specify this parameter if the RAS VDI Agent is dedicated.
URL and Mail Redirection values.
Enable or disable the 'Support Shell URL Namespace Objects' option.
Set the Drag and Drop option.
Deprecated: use FileTransferMode instead. Enable or disable the 'Allow file transfer' option.
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Enable or disable the 'Remove client name from printer name' option.
Enable or disable the 'Remove session number from printer name' option.
Printer Name Format
falseEnable or disable the 'Enable Drive Redirection Cache' option.
Manage RDP transport protocol.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the dedicated VDIAgent specified in the VDIAgent parameter.
The preferred Connection Broker ID.
Use all guests.
Cost Optimize Timeout in seconds. Applicable to: AVD (Experimental) and Azure.
Enable Cost Optimize. Applicable to: AVD (Experimental) and Azure.
The Feed URL. Applicable to: AVD (Experimental).
The Web Access URL. Applicable to: AVD (Experimental).
Active Directory Domain Service Type
The access key ID of the Amazon Web Service account. Applicable to: AWSEC2.
The secret access key of the Amazon Web Service account. Applicable to: AWSEC2.
Amazon Elastic Compute Cloud Location Type
The region name of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
The region code of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.
The endpoint URL of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2. Example: https://ec2.us-east01.amazonaws.com.
HyperV Version
HyperV Failover Cluster Version
Starting MAC Address. Applicable to: HyperV Failover.
Ending MAC Address. Applicable to: HyperV Failover.
Specifies if the MAC Management is enabled or not. Applicable to: HyperV Failover.
Nutanix Version
Domain Target OU. Applicable to: Remote PC Dynamic.
The subnet of the remote PC dynamic. Applicable to: Remote PC Dynamic.
Scale Version
Vmware VCenter Version
Resource Pool. Applicable to: VCenter
Vmware ESX Version
No Content
Unauthorized
Not Found
Delete a Provider server from a site. The VDI agent will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.
Provider ID
If this parameter is included, the VDI agent will not be uninstalled from the server. To uninstall the agent, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials if needed using the Username and Password parameters.
An administrator account to remotely uninstall the VDI agent from the server. If this parameter is omitted, your RAS admin username (and password) will be used by default.
The password of the account specified in the Username parameter.
No Content
Unauthorized
Not Found
No content
Get a list of the schedule setting's target native hosts.
The ID of the Schedule setting for which to retrieve the target settings.
Success
Unauthorized
Not Found
Add a Schedule target setting.
The ID of the Schedule setting to modify.
Pool Id
GUID
Guest Name
Host Azure ID
Created
Unauthorized
Conflict
No content
Remove a Schedule target setting.
The ID of a Schedule setting to remove.
Pool Id
GUID
Guest Name
Host Azure ID
No Content
Unauthorized
Not Found
No content
Creates Azure Virtual Desktop Hosts from a Templated Azure Virtual Desktop Host Pool.
Site ID for which to create the Azure Virtual Desktop Host (optional)
Host Pool Id of the AVD Host.
Number of Hosts to create from template.
No Content
Bad Request
Unauthorized
No content
Removes Azure Virtual Desktop Hosts from a Templated Azure Virtual Desktop Host Pool.
The Templated Azure Virtual Desktop Host Pool ID from which to remove the Azure Virtual Desktop Hosts.
The ID of the target host VM.
Site ID for which to remove the Azure Virtual Desktop Host (optional)
No Content
Bad Request
Unauthorized
No content
Creates a new disable Schedule.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
Unauthorized
Conflict
Retrieve a list of Provider servers with status information.
Site ID for which Provider servers with status information will be retrieved (optional)
Filter the result by server name (optional)
Success
Unauthorized
Not Found
Creates a new Startup Schedule.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
Unauthorized
Conflict
Retrieve the host VM list in real-time.
Site ID from which to retrieve the host VM list (optional).
Success
Bad Request
Unauthorized
Retrieve the host VM list from a Provider in real-time.
The ID of a Provider server from which to obtain the VM list.
Success
Bad Request
Unauthorized
Retrieve the specified host VM from a Provider in real-time.
The ID of a Provider server from which to retrieve the specified VM.
The ID of a host VM for which to retrieve the information.
Success
Bad Request
Unauthorized
Creates a new Reboot Schedule.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
Unauthorized
Conflict
Modify a host assignment.
The ID of the Provider server on which the target Host resides.
The ID of the host VM.
Site ID.
Update persistence configuration of the VDI Host
The name of the user account to which to assign the Host.
The name of the device to which to assign the Host.
The SID of the user account to which to assign the Host.
No Content
Unauthorized
Not Found
No content
Remove a host assignment.
The ID of the Provider server on which the target Host resides.
The ID of the host VM.
Site ID.
No Content
Unauthorized
Not Found
No content
Create a new VCenter Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Created
Unauthorized
Conflict
Invoke the VDI Process Command to send the Kill command to the Process with specified Process ID.
The ID of the provider.
VM ID.
Process ID.
No Content
Unauthorized
Not Found
No content
Create a new VMwareESX Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Create provider of type VMwareESXi
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
The preferred Connection Broker ID.
Use all guests.
Created
Unauthorized
Conflict
Invoke the VDI Session to send the Disconnect command to the VDI Host with specified VM ID.
The ID of the provider.
VM ID.
No Content
Unauthorized
Not Found
No content
Retrieve a list of Host Sessions by Site Id.
Site Id from which to retrieve the Host VM list (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Retrieve a list of Host Sessions by Provider Id.
The Provider Id from which to retrieve the Hosts.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Retrieve the Host Sessions.
The Provider Id from which to retrieve the Hosts.
The ID of the Host for which to retrieve the status.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Creates a new Startup Schedule.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
Unauthorized
Conflict
Create a new Scale Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Created
Unauthorized
Conflict
Retrieve the host VM list in real-time.
Site ID from which to retrieve the host VM list (optional).
The ID of the VDI Template for which to retrieve the hosts of (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Retrieve the host VM list from a Provider in real-time.
The ID of a Provider server from which to obtain the VM list.
Success
Unauthorized
Not Found
Retrieve the specified host VM from a Provider in real-time.
The ID of a Provider server from which to retrieve the specified VM.
The ID of a host VM for which to retrieve the information.
Success
Unauthorized
Not Found
Remove a RAS Guest Agent from a host VM, thus making it a plain VM, not a host VM recognized by Parallels RAS.
The ID of the Provider server where the target host VM resides.
The ID of the target host VM.
If this parameter is included, the VDI Guest agent will not be uninstalled from the server. To uninstall the agent, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials if needed using the Username and Password parameters.
An administrator account to remotely uninstall the RAS Guest Agent from the VM. If this parameter is omitted, your RAS admin username and password will be used by default.
The password of the account specified in the Username parameter.
No Content
Unauthorized
Not Found
No content
Create a new RemotePCDynamic Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.
Created
Unauthorized
Conflict
Creates a new Shutdown Schedule.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
Unauthorized
Conflict
Get a list of the schedule setting's target native hosts.
The ID of the Schedule setting for which to retrieve the target settings.
Success
Unauthorized
Not Found
Add a Schedule target setting.
The ID of the Schedule setting to modify.
Pool Id
GUID
Guest Name
Host Azure ID
Created
Unauthorized
Conflict
No content
Remove a Schedule target setting.
The ID of a Schedule setting to remove.
Pool Id
GUID
Guest Name
Host Azure ID
No Content
Unauthorized
Not Found
No content
Invoke the VDI Session to send a message to the RD Session Host Session with specified Session ID.
The ID of the provider.
VM ID.
To invoke the VDI session
The message title for the session message.
The session message to be sent.
No Content
Unauthorized
No content
Invoke the VDI Session to send the LogOff command to the VDI Host with specified VM ID.
The ID of the provider.
VM ID.
No Content
Unauthorized
Not Found
No content
Creates an Azure Virtual Desktop Host from a Standalone Azure Virtual Desktop Host Pool.
Site ID for which to create the Azure Virtual Desktop Host (optional)
Host Pool Id of the AVD Host.
The Azure Host ID of the AVD Host. Found as Resource ID in Azure.
No Content
Bad Request
Unauthorized
No content
Removes an Azure Virtual Desktop Host from a Standalone Azure Virtual Desktop Host Pool.
Site ID for which to remove the Azure Virtual Desktop Host (optional)
Host Pool Id.
The Azure Host ID.
No Content
Bad Request
Unauthorized
No content
Retrieve information about one or multiple Schedule setting.
Site ID from which to retrieve the Schedule setting (optional).
The name of the Schedule setting for which to retrieve the information. This must be the actual Schedule setting name used in the RAS connections.
Success
Unauthorized
Not Found
Retrieve information about a particular Schedule setting by ID.
The ID of the Schedule setting for which to retrieve the information.
Success
Unauthorized
Not Found
Modify properties of a Schedule setting.
The ID of the Schedule setting to modify.
A new name for the scheduler job.
Whether to enable or disable the schedule.
Schedule description.
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
No Content
Unauthorized
Not Found
Retrieve the list of all statuses.
Site ID of which the sessions will be retrieved (optional)
Filter the result by server name (optional)
Success
Unauthorized
Not Found
Retrieve a list of statuses for a specific Provider.
The ID of the Provider server.
Success
Unauthorized
Not Found
Retrieve a specific Host Status.
The ID of the Provider server.
VM ID.
Success
Unauthorized
Not Found
Retrieve a list of Host Session Processes by Site Id.
Site Id from which to retrieve the Host VM list (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Retrieve a list of Host Session Processes by Provider Id.
The Provider Id from which to retrieve the Hosts.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Retrieve the Host Session Processes.
The Provider Id from which to retrieve the Hosts.
The ID of the Host for which to retrieve the status.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Unauthorized
Not Found
Retrieve a list of Host status by Site Id.
Site Id from which to retrieve the Host VM list (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Bad Request
Unauthorized
Retrieve a list of Host status by Provider Id.
The Provider Id from which to retrieve the Hosts.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Bad Request
Unauthorized
Retrieve the Host status.
The Provider Id from which to retrieve the Hosts.
The ID of the Host for which to retrieve the status.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Bad Request
Unauthorized
Create provider of type AVD
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Azure Subscription ID.
Azure Tenant ID.
Azure Authentication URL.
Azure Management URL.
Azure Resource URI.
AVD Version (Experimental)
Created
Unauthorized
Conflict
Create provider of type Azure
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The preferred Connection Broker ID.
Use all guests.
Azure Subscription ID.
Azure Tenant ID.
Azure Authentication URL.
Azure Management URL.
Azure Resource URI.
Azure Version
No content
No content
No content
Create provider of type HyperV
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
HyperV Version
Create provider of type Nutanix
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Nutanix Version
Create provider of type RemotePCStatic
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Remote PC Static Version
Create provider of type HyperVFailover
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
HyperV Failover Cluster Version
Create provider of type VCenter
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Vmware VCenter Version
Create provider of type Scale
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Scale Version
Create provider of type RemotePCDynamic
The name of the Provider.
A Provider server FQDN or IP addresses.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
FQDN or IP address of the server where the RAS VDI Agent is running.
A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.
The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.
The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.
The preferred Connection Broker ID.
Use all guests.
Remote PC Dynamic Version
POST /api/Provider/avd HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 304
{
"name": "text",
"server": "text",
"siteId": 1,
"providerUsername": "text",
"providerPassword": "text",
"port": 1,
"preferredBrokerId": 1,
"useAllGuests": true,
"subscriptionID": "text",
"tenantID": "text",
"authenticationURL": "text",
"managementURL": "text",
"resourceURI": "text",
"avdVersion": [
"0 = AVD",
"1441792 = AVD_Depr"
]
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"version": [
"0 = AVD",
"1441792 = AVD_Depr"
],
"graphURL": "text",
"feedURL": "text",
"adType": [
"1 = WindowsServerADDS",
"2 = AzureADDS"
],
"webAccessURL": "text",
"vdiAzureCloudInfo": {
"authenticationURL": "text",
"managementURL": "text",
"resourceURI": "text",
"subscriptionID": "text",
"tenantID": "text",
"costOptimizeTimeout": 1,
"enableCostOptimize": true
}
}POST /api/Provider/azure HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 319
{
"name": "text",
"server": "text",
"siteId": 1,
"vdiAgent": "text",
"providerUsername": "text",
"providerPassword": "text",
"preferredBrokerId": 1,
"useAllGuests": true,
"subscriptionID": "text",
"tenantID": "text",
"authenticationURL": "text",
"managementURL": "text",
"resourceURI": "text",
"azureVersion": [
"0 = Azure",
"1376256 = Azure_Depr"
]
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"version": [
"0 = Azure",
"1376256 = Azure_Depr"
],
"vdiAzureCloudInfo": {
"authenticationURL": "text",
"managementURL": "text",
"resourceURI": "text",
"subscriptionID": "text",
"tenantID": "text",
"costOptimizeTimeout": 1,
"enableCostOptimize": true
}
}GET /api/Provider/VM/AVDHost/Schedule HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}
]GET /api/Provider/VM/AVDHost/Schedule/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}PUT /api/Provider/VM/AVDHost/Schedule/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 580
{
"newName": "text",
"enabled": true,
"description": "text",
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}DELETE /api/Provider/VM/AVDHost/Schedule/{id} HTTP/1.1
Host:
Accept: */*
GET /api/Provider/VM/AVDHost/Schedule/{id}/Messages HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
]POST /api/Provider/VM/AVDHost/Schedule/{id}/Messages HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112
{
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}GET /api/Provider/VM/AVDHost/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}PUT /api/Provider/VM/AVDHost/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112
{
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}DELETE /api/Provider/VM/AVDHost/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host:
Accept: */*
GET /api/Provider/VM/VDIHost/Schedule/{id}/Messages HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
]POST /api/Provider/VM/VDIHost/Schedule/{id}/Messages HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112
{
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}GET /api/Provider/VM/VDIHost/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}PUT /api/Provider/VM/VDIHost/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112
{
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}DELETE /api/Provider/VM/VDIHost/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}POST /api/Provider/VM/VDIHost/Schedule/Disable HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597
{
"name": "text",
"siteId": 1,
"enabled": true,
"description": "text",
"type": 1,
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}GET /api/Provider/VM/VDIHost/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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"device": "text"
}
]GET /api/Provider/{providerId}/VM/VDIHost/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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"device": "text"
}
]GET /api/Provider/{providerId}/VM/{id}/VDIHost/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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"device": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}POST /api/Provider/VM/VDIHost/Schedule/Reboot HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597
{
"name": "text",
"siteId": 1,
"enabled": true,
"description": "text",
"type": 1,
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}POST /api/Provider/remotepcstatic/{id}/remotepc/Import HTTP/1.1
Host:
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20
{
"CsvFile": "binary"
}GET /api/Provider/remotepcstatic/{id}/remotepc HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"name": "text",
"mac": "text",
"subnet": "text"
}
]POST /api/Provider/remotepcstatic/{id}/remotepc HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 58
{
"remotePCStaticName": "text",
"mac": "text",
"subnet": "text"
}PUT /api/Provider/remotepcstatic/{id}/remotepc/{remotePCStaticId} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 58
{
"remotePCStaticName": "text",
"mac": "text",
"subnet": "text"
}DELETE /api/Provider/remotepcstatic/{id}/remotepc/{remotePCStaticId} HTTP/1.1
Host:
Accept: */*
GET /api/Provider/VM HTTP/1.1
Host:
Accept: */*
[
{
"siteId": 1,
"name": "text",
"id": "text",
"providerId": 1,
"user": "text",
"server": "text",
"state": [
"0 = Unknown",
"1 = On",
"2 = Off",
"3 = Paused",
"9 = CloningFailed",
"17 = CloningCanceled"
],
"nativePoolId": "text",
"isHost": true,
"isTemplate": true,
"ip": "text"
}
]GET /api/Provider/{providerId}/VM HTTP/1.1
Host:
Accept: */*
[
{
"siteId": 1,
"name": "text",
"id": "text",
"providerId": 1,
"user": "text",
"server": "text",
"state": [
"0 = Unknown",
"1 = On",
"2 = Off",
"3 = Paused",
"9 = CloningFailed",
"17 = CloningCanceled"
],
"nativePoolId": "text",
"isHost": true,
"isTemplate": true,
"ip": "text"
}
]GET /api/Provider/{providerId}/VM/{id} HTTP/1.1
Host:
Accept: */*
{
"siteId": 1,
"name": "text",
"id": "text",
"providerId": 1,
"user": "text",
"server": "text",
"state": [
"0 = Unknown",
"1 = On",
"2 = Off",
"3 = Paused",
"9 = CloningFailed",
"17 = CloningCanceled"
],
"nativePoolId": "text",
"isHost": true,
"isTemplate": true,
"ip": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}POST /api/Provider/VM/AVDHost/Schedule/Shutdown HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597
{
"name": "text",
"siteId": 1,
"enabled": true,
"description": "text",
"type": 1,
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}POST /api/Provider HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 84
{
"name": "text",
"server": "text",
"siteId": 1,
"preferredBrokerId": 1,
"useAllGuests": true
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1
}GET /api/Provider HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1
}
]GET /api/Provider/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1
}PUT /api/Provider/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 3005
{
"enabled": true,
"name": "text",
"newServer": "text",
"description": "text",
"directAddress": "text",
"port": 1,
"vdiAgent": "text",
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"autoPreferredBroker": false,
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"providerUsername": "text",
"providerPassword": "text",
"vdiPort": 1,
"preferredBrokerId": 1,
"useAllGuests": true,
"costOptimizeTimeout": 1,
"enableCostOptimize": true,
"feedURL": "text",
"webAccessURL": "text",
"adType": [
"1 = WindowsServerADDS",
"2 = AzureADDS"
],
"accessKeyID": "text",
"secretAccessKey": "text",
"locationType": [
"0 = Default",
"1 = OptedIn",
"2 = EndpointUrl"
],
"regionName": "text",
"regionCode": "text",
"endpointUrl": "text",
"hyperVVersion": [
"0 = HyperV",
"11 = Win2012R2Std",
"12 = Win2012R2Dtc",
"13 = Win2012R2Srv",
"14 = Win2016Std",
"15 = Win2016Dtc",
"16 = Win2016Srv",
"17 = Win2019Std",
"18 = Win2019Dtc",
"19 = Win2019Srv",
"20 = Win2022Std",
"21 = Win2022Dtc",
"22 = Win2022DtcAzure",
"589824 = HyperV_Depr",
"589835 = Win2012R2Std_Depr",
"589836 = Win2012R2Dtc_Depr",
"589837 = Win2012R2Srv_Depr",
"589838 = Win2016Std_Depr",
"589839 = Win2016Dtc_Depr",
"589840 = Win2016Srv_Depr",
"589841 = Win2019Std_Depr",
"589842 = Win2019Dtc_Depr",
"589843 = Win2019Srv_Depr",
"589844 = Win2022Std_Depr",
"589845 = Win2022Dtc_Depr",
"589846 = Win2022DtcAzure_Depr"
],
"hyperVFailoverVersion": [
"0 = HyperVFailoverCluster",
"1 = Ent",
"2 = Dtc",
"3 = Win2012",
"4 = Win2012R2",
"5 = Win2016",
"6 = Win2019",
"7 = Win2022",
"1048576 = HyperVFailoverCluster_Depr",
"1048577 = Ent_Depr",
"1048578 = Dtc_Depr",
"1048579 = Win2012_Depr",
"1048580 = Win2012R2_Depr",
"1048581 = Win2016_Depr",
"1048582 = Win2019_Depr",
"1048583 = Win2022_Depr"
],
"startMacAddress": "text",
"endMacAddress": "text",
"enableMacManagement": true,
"nutanixVersion": [
"0 = Nutanix",
"4 = v5_15",
"5 = v5_20",
"6 = v6_5",
"1179648 = Nutanix_Depr",
"1179652 = v5_15_Depr",
"1179653 = v5_20_Depr",
"1179654 = v6_5_Depr"
],
"domainTargetOU": "text",
"remotePCDynamicSubnet": "text",
"scaleVersion": [
"0 = Scale",
"4 = v8_9",
"5 = v9_1",
"6 = v9_2",
"1310720 = Scale_Depr",
"1310724 = v8_9_Depr",
"1310725 = v9_1_Depr"
],
"vCenterVersion": [
"0 = VmwareVCenter",
"7 = v6_5",
"8 = v6_7",
"9 = v7_0",
"10 = v8_0",
"983040 = VmwareVCenter_Depr",
"983047 = v6_5_Depr",
"983048 = v6_7_Depr",
"983049 = v7_0_Depr",
"983050 = v8_0_Depr"
],
"resourcePool": "text",
"vmwareESXiVersion": [
"0 = VmwareESXi",
"11 = v6_5",
"12 = v6_7",
"13 = v7_0",
"14 = v8_0",
"655360 = VmwareESXi_Depr",
"655371 = v6_5_Depr",
"655372 = v6_7_Depr",
"655373 = v7_0_Depr",
"655374 = v8_0_Depr"
]
}DELETE /api/Provider/{id} HTTP/1.1
Host:
Accept: */*
GET /api/Provider/VM/AVDHost/Schedule/{id}/Target HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 2
{}[
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
]POST /api/Provider/VM/AVDHost/Schedule/{id}/Target HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 66
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}DELETE /api/Provider/VM/AVDHost/Schedule/{id}/Target HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 66
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}POST /api/Provider/VM/AVDHost/Templated HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 34
{
"hostPoolId": 1,
"numberOfHosts": 1
}DELETE /api/Provider/{providerId}/VM/{id}/AVDHost/Templated HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}POST /api/Provider/VM/AVDHost/Schedule/Disable HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597
{
"name": "text",
"siteId": 1,
"enabled": true,
"description": "text",
"type": 1,
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}POST /api/Provider/{providerId}/VM/{id}/Stop HTTP/1.1
Host:
Accept: */*
GET /api/Provider/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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"preferredBroker": "text",
"highAvailabilityState": [
"0 = Off",
"1 = On_Pref",
"2 = On_Auto"
],
"activeConnections": 1,
"vdiAgent": "text",
"friendlyName": "text"
}
]GET /api/Provider/{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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"preferredBroker": "text",
"highAvailabilityState": [
"0 = Off",
"1 = On_Pref",
"2 = On_Auto"
],
"activeConnections": 1,
"vdiAgent": "text",
"friendlyName": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}POST /api/Provider/VM/AVDHost/Schedule/Startup HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597
{
"name": "text",
"siteId": 1,
"enabled": true,
"description": "text",
"type": 1,
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}POST /api/Provider/{providerId}/VM/{id}/Suspend HTTP/1.1
Host:
Accept: */*
GET /api/Provider/VM/AVDHost HTTP/1.1
Host:
Accept: */*
[
{
"siteId": 1,
"id": "text",
"providerId": 1,
"host": "text",
"avdAgent": "text",
"hostPool": "text",
"workspace": "text",
"location": "text",
"resourceGroup": "text"
}
]GET /api/Provider/{providerId}/VM/AVDHost HTTP/1.1
Host:
Accept: */*
[
{
"siteId": 1,
"id": "text",
"providerId": 1,
"host": "text",
"avdAgent": "text",
"hostPool": "text",
"workspace": "text",
"location": "text",
"resourceGroup": "text"
}
]GET /api/Provider/{providerId}/VM/{id}/AVDHost HTTP/1.1
Host:
Accept: */*
{
"siteId": 1,
"id": "text",
"providerId": 1,
"host": "text",
"avdAgent": "text",
"hostPool": "text",
"workspace": "text",
"location": "text",
"resourceGroup": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}POST /api/Provider/VM/AVDHost/Schedule/Reboot HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597
{
"name": "text",
"siteId": 1,
"enabled": true,
"description": "text",
"type": 1,
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}POST /api/Provider/{providerId}/VM/{id}/Reset HTTP/1.1
Host:
Accept: */*
GET /api/Provider/VM/VDIHost/Assignment HTTP/1.1
Host:
Accept: */*
PUT /api/Provider/{providerId}/VM/{vmId}/VDIHost/Assignment HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 44
{
"user": "text",
"device": "text",
"sid": "text"
}DELETE /api/Provider/{providerId}/VM/{vmId}/VDIHost/Assignment HTTP/1.1
Host:
Accept: */*
POST /api/Provider/{providerId}/VM/{id}/Start HTTP/1.1
Host:
Accept: */*
POST /api/Provider/{providerId}/VM/{vmId}/Host/Process/{id}/Kill HTTP/1.1
Host:
Accept: */*
POST /api/Provider/{providerId}/VM/{vmId}/VDIHost/Disconnect HTTP/1.1
Host:
Accept: */*
GET /api/Provider/VM/VDIHost/Session 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"device": "text"
}
]GET /api/Provider/{providerId}/VM/VDIHost/Session 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"device": "text"
}
]GET /api/Provider/{providerId}/VM/{id}/VDIHost/Session 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"device": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}POST /api/Provider/VM/VDIHost/Schedule/Startup HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597
{
"name": "text",
"siteId": 1,
"enabled": true,
"description": "text",
"type": 1,
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}GET /api/Provider/VM/VDIHost HTTP/1.1
Host:
Accept: */*
[
{
"siteId": 1,
"name": "text",
"id": "text",
"providerId": 1,
"templateId": 1,
"poolId": 1,
"timeLastUsed": "2025-12-14T03:07:50.972Z",
"timeCreated": "2025-12-14T03:07:50.972Z"
}
]GET /api/Provider/{providerId}/VM/VDIHost HTTP/1.1
Host:
Accept: */*
[
{
"siteId": 1,
"name": "text",
"id": "text",
"providerId": 1,
"templateId": 1,
"poolId": 1,
"timeLastUsed": "2025-12-14T03:07:50.972Z",
"timeCreated": "2025-12-14T03:07:50.972Z"
}
]GET /api/Provider/{providerId}/VM/{id}/VDIHost HTTP/1.1
Host:
Accept: */*
{
"siteId": 1,
"name": "text",
"id": "text",
"providerId": 1,
"templateId": 1,
"poolId": 1,
"timeLastUsed": "2025-12-14T03:07:50.972Z",
"timeCreated": "2025-12-14T03:07:50.972Z"
}DELETE /api/Provider/{providerId}/VM/{id}/VDIHost HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}POST /api/Provider/VM/VDIHost/Schedule/Shutdown HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597
{
"name": "text",
"siteId": 1,
"enabled": true,
"description": "text",
"type": 1,
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}GET /api/Provider/VM/VDIHost/Schedule/{id}/Target HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 2
{}[
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
]POST /api/Provider/VM/VDIHost/Schedule/{id}/Target HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 66
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}DELETE /api/Provider/VM/VDIHost/Schedule/{id}/Target HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 66
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}POST /api/Provider/{providerId}/VM/{id}/Restart HTTP/1.1
Host:
Accept: */*
POST /api/Provider/{providerId}/VM/{vmId}/VDIHost/SendMsg HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 36
{
"msgTitle": "text",
"message": "text"
}POST /api/Provider/{providerId}/VM/{vmId}/VDIHost/LogOff HTTP/1.1
Host:
Accept: */*
POST /api/Provider/VM/AVDHost/Standalone HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33
{
"hostPoolId": 1,
"azureId": "text"
}DELETE /api/Provider/VM/AVDHost/Standalone HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33
{
"hostPoolId": 1,
"azureId": "text"
}GET /api/Provider/VM/VDIHost/Schedule HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}
]GET /api/Provider/VM/VDIHost/Schedule/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"siteID": 1,
"objType": [
"44 = RDS",
"92 = AVD",
"100 = VDI"
],
"action": [
"0 = Disable",
"1 = Reboot",
"3 = Startup",
"4 = Shutdown",
"7 = Recreate"
],
"targetType": [
"0 = Host",
"1 = HostPool"
],
"enabled": true,
"name": "text",
"description": "text",
"type": 1,
"targetIDs": [
1
],
"targetNativeHosts": [
{
"poolId": 1,
"guid": "text",
"guestName": "text",
"hostAzureID": "text"
}
],
"trigger": {
"startDateTime": "2025-12-14T03:07:50.972Z",
"endDateTime": "2025-12-14T03:07:50.972Z",
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"durationInSecs": 1,
"completeIn": 1
},
"options": {
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
],
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}
}PUT /api/Provider/VM/VDIHost/Schedule/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 580
{
"newName": "text",
"enabled": true,
"description": "text",
"startDateTime": "2025-12-14T03:07:50.972Z",
"durationInSecs": 1,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"completeIn": 1,
"poolMembersType": 1,
"percentageMembers": 1,
"membersToStart": 1,
"powerOnAssignedPoolMembers": 1,
"enableDrainMode": true,
"forceServerRebootAfter": 1,
"enforceScheduleInactiveHost": true,
"onDisable": true
}DELETE /api/Provider/VM/VDIHost/Schedule/{id} HTTP/1.1
Host:
Accept: */*
GET /api/Provider/VM/Host/Status HTTP/1.1
Host:
Accept: */*
[
{
"name": "text",
"server": "text",
"state": [
"0 = On",
"1 = OnAgentConnected",
"2 = Off",
"3 = Paused",
"4 = RASTemplate",
"5 = MaintenanceMode",
"6 = Cloning",
"7 = Personalizing",
"8 = FailedToCreate",
"-1 = Unknown"
],
"connection": [
"0 = Disconnected",
"1 = Preparing",
"2 = Waiting",
"3 = Connected",
"4 = RASTemplate",
"-1 = Unknown"
],
"templateName": "text",
"templateID": 1,
"templateType": [
"0 = SingleSession",
"1 = MultiSession"
],
"user": "text",
"ip": "text",
"hostID": "text",
"providerID": 1,
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"session": {
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2025-12-14T03:07:50.972Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2025-12-14T03:07:50.972Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text",
"hostId": "text"
},
"isMaintenance": true,
"isTemplate": true,
"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"
]
}
]GET /api/Provider/{providerId}/VM/Host/Status HTTP/1.1
Host:
Accept: */*
[
{
"name": "text",
"server": "text",
"state": [
"0 = On",
"1 = OnAgentConnected",
"2 = Off",
"3 = Paused",
"4 = RASTemplate",
"5 = MaintenanceMode",
"6 = Cloning",
"7 = Personalizing",
"8 = FailedToCreate",
"-1 = Unknown"
],
"connection": [
"0 = Disconnected",
"1 = Preparing",
"2 = Waiting",
"3 = Connected",
"4 = RASTemplate",
"-1 = Unknown"
],
"templateName": "text",
"templateID": 1,
"templateType": [
"0 = SingleSession",
"1 = MultiSession"
],
"user": "text",
"ip": "text",
"hostID": "text",
"providerID": 1,
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"session": {
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2025-12-14T03:07:50.972Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2025-12-14T03:07:50.972Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text",
"hostId": "text"
},
"isMaintenance": true,
"isTemplate": true,
"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"
]
}
]GET /api/Provider/{providerId}/VM/{vmId}/Host/Status HTTP/1.1
Host:
Accept: */*
{
"name": "text",
"server": "text",
"state": [
"0 = On",
"1 = OnAgentConnected",
"2 = Off",
"3 = Paused",
"4 = RASTemplate",
"5 = MaintenanceMode",
"6 = Cloning",
"7 = Personalizing",
"8 = FailedToCreate",
"-1 = Unknown"
],
"connection": [
"0 = Disconnected",
"1 = Preparing",
"2 = Waiting",
"3 = Connected",
"4 = RASTemplate",
"-1 = Unknown"
],
"templateName": "text",
"templateID": 1,
"templateType": [
"0 = SingleSession",
"1 = MultiSession"
],
"user": "text",
"ip": "text",
"hostID": "text",
"providerID": 1,
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"session": {
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2025-12-14T03:07:50.972Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2025-12-14T03:07:50.972Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text",
"hostId": "text"
},
"isMaintenance": true,
"isTemplate": true,
"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"
]
}GET /api/Provider/VM/VDIHost/Session/Processes 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"device": "text"
}
]GET /api/Provider/{providerId}/VM/VDIHost/Session/Processes 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"device": "text"
}
]GET /api/Provider/{providerId}/VM/{id}/VDIHost/Session/Processes 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"device": "text"
}GET /api/Provider/VM/AVDHost/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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"avdAgent": "text",
"subnetName": "text"
}
]GET /api/Provider/{providerId}/VM/AVDHost/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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"avdAgent": "text",
"subnetName": "text"
}
]GET /api/Provider/{providerId}/VM/{id}/AVDHost/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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"avdAgent": "text",
"subnetName": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"adminCredentials": [
{
"enabled": true,
"priority": 1,
"username": "text"
}
],
"version": [
"0 = HyperV",
"11 = Win2012R2Std",
"12 = Win2012R2Dtc",
"13 = Win2012R2Srv",
"14 = Win2016Std",
"15 = Win2016Dtc",
"16 = Win2016Srv",
"17 = Win2019Std",
"18 = Win2019Dtc",
"19 = Win2019Srv",
"20 = Win2022Std",
"21 = Win2022Dtc",
"22 = Win2022DtcAzure",
"589824 = HyperV_Depr",
"589835 = Win2012R2Std_Depr",
"589836 = Win2012R2Dtc_Depr",
"589837 = Win2012R2Srv_Depr",
"589838 = Win2016Std_Depr",
"589839 = Win2016Dtc_Depr",
"589840 = Win2016Srv_Depr",
"589841 = Win2019Std_Depr",
"589842 = Win2019Dtc_Depr",
"589843 = Win2019Srv_Depr",
"589844 = Win2022Std_Depr",
"589845 = Win2022Dtc_Depr",
"589846 = Win2022DtcAzure_Depr"
]
}POST /api/Provider/hyperv HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 779
{
"name": "text",
"server": "text",
"siteId": 1,
"vdiAgent": "text",
"providerUsername": "text",
"providerPassword": "text",
"port": 1,
"preferredBrokerId": 1,
"useAllGuests": true,
"hyperVVersion": [
"0 = HyperV",
"11 = Win2012R2Std",
"12 = Win2012R2Dtc",
"13 = Win2012R2Srv",
"14 = Win2016Std",
"15 = Win2016Dtc",
"16 = Win2016Srv",
"17 = Win2019Std",
"18 = Win2019Dtc",
"19 = Win2019Srv",
"20 = Win2022Std",
"21 = Win2022Dtc",
"22 = Win2022DtcAzure",
"589824 = HyperV_Depr",
"589835 = Win2012R2Std_Depr",
"589836 = Win2012R2Dtc_Depr",
"589837 = Win2012R2Srv_Depr",
"589838 = Win2016Std_Depr",
"589839 = Win2016Dtc_Depr",
"589840 = Win2016Srv_Depr",
"589841 = Win2019Std_Depr",
"589842 = Win2019Dtc_Depr",
"589843 = Win2019Srv_Depr",
"589844 = Win2022Std_Depr",
"589845 = Win2022Dtc_Depr",
"589846 = Win2022DtcAzure_Depr"
]
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"adminCredentials": [
{
"enabled": true,
"priority": 1,
"username": "text"
}
],
"version": [
"0 = Nutanix",
"4 = v5_15",
"5 = v5_20",
"6 = v6_5",
"1179648 = Nutanix_Depr",
"1179652 = v5_15_Depr",
"1179653 = v5_20_Depr",
"1179654 = v6_5_Depr"
]
}POST /api/Provider/nutanix HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 324
{
"name": "text",
"server": "text",
"siteId": 1,
"vdiAgent": "text",
"providerUsername": "text",
"providerPassword": "text",
"port": 1,
"preferredBrokerId": 1,
"useAllGuests": true,
"nutanixVersion": [
"0 = Nutanix",
"4 = v5_15",
"5 = v5_20",
"6 = v6_5",
"1179648 = Nutanix_Depr",
"1179652 = v5_15_Depr",
"1179653 = v5_20_Depr",
"1179654 = v6_5_Depr"
]
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"adminCredentials": [
{
"enabled": true,
"priority": 1,
"username": "text"
}
],
"version": [
"1 = RemotePCStatic",
"1507329 = RemotePCStatic_Depr"
],
"vdipcListHash": 1,
"remotePCs": [
{
"id": "text",
"name": "text",
"mac": "text",
"subnet": "text"
}
]
}POST /api/Provider/remotepcstatic HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 242
{
"name": "text",
"server": "text",
"siteId": 1,
"vdiAgent": "text",
"providerUsername": "text",
"providerPassword": "text",
"port": 1,
"preferredBrokerId": 1,
"useAllGuests": true,
"remotePCStaticVersion": [
"1 = RemotePCStatic",
"1507329 = RemotePCStatic_Depr"
]
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"adminCredentials": [
{
"enabled": true,
"priority": 1,
"username": "text"
}
],
"version": [
"0 = AWSEC2",
"1638400 = AWSEC2_Depr"
],
"locationType": [
"0 = Default",
"1 = OptedIn",
"2 = EndpointUrl"
],
"regionName": "text",
"accessKeyId": "text",
"regionCode": "text",
"endpointUrl": "text"
}POST /api/Provider/awsec2 HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 203
{
"name": "text",
"server": "text",
"siteId": 1,
"vdiAgent": "text",
"preferredBrokerId": 1,
"useAllGuests": true,
"awseC2Version": [
"0 = AWSEC2",
"1638400 = AWSEC2_Depr"
],
"accessKeyID": "text",
"secretAccessKey": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"adminCredentials": [
{
"enabled": true,
"priority": 1,
"username": "text"
}
],
"version": [
"0 = HyperVFailoverCluster",
"1 = Ent",
"2 = Dtc",
"3 = Win2012",
"4 = Win2012R2",
"5 = Win2016",
"6 = Win2019",
"7 = Win2022",
"1048576 = HyperVFailoverCluster_Depr",
"1048577 = Ent_Depr",
"1048578 = Dtc_Depr",
"1048579 = Win2012_Depr",
"1048580 = Win2012R2_Depr",
"1048581 = Win2016_Depr",
"1048582 = Win2019_Depr",
"1048583 = Win2022_Depr"
],
"macManagementInfo": {
"startMacAddress": "text",
"endMacAddress": "text"
},
"enableMacManagement": true
}POST /api/Provider/hypervfailover HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 517
{
"name": "text",
"server": "text",
"siteId": 1,
"vdiAgent": "text",
"providerUsername": "text",
"providerPassword": "text",
"port": 1,
"preferredBrokerId": 1,
"useAllGuests": true,
"hyperVFailoverVersion": [
"0 = HyperVFailoverCluster",
"1 = Ent",
"2 = Dtc",
"3 = Win2012",
"4 = Win2012R2",
"5 = Win2016",
"6 = Win2019",
"7 = Win2022",
"1048576 = HyperVFailoverCluster_Depr",
"1048577 = Ent_Depr",
"1048578 = Dtc_Depr",
"1048579 = Win2012_Depr",
"1048580 = Win2012R2_Depr",
"1048581 = Win2016_Depr",
"1048582 = Win2019_Depr",
"1048583 = Win2022_Depr"
]
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"adminCredentials": [
{
"enabled": true,
"priority": 1,
"username": "text"
}
],
"version": [
"0 = VmwareVCenter",
"7 = v6_5",
"8 = v6_7",
"9 = v7_0",
"10 = v8_0",
"983040 = VmwareVCenter_Depr",
"983047 = v6_5_Depr",
"983048 = v6_7_Depr",
"983049 = v7_0_Depr",
"983050 = v8_0_Depr"
],
"resourcePool": "text"
}POST /api/Provider/vcenter HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 361
{
"name": "text",
"server": "text",
"siteId": 1,
"vdiAgent": "text",
"providerUsername": "text",
"providerPassword": "text",
"port": 1,
"preferredBrokerId": 1,
"useAllGuests": true,
"vCenterVersion": [
"0 = VmwareVCenter",
"7 = v6_5",
"8 = v6_7",
"9 = v7_0",
"10 = v8_0",
"983040 = VmwareVCenter_Depr",
"983047 = v6_5_Depr",
"983048 = v6_7_Depr",
"983049 = v7_0_Depr",
"983050 = v8_0_Depr"
]
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"adminCredentials": [
{
"enabled": true,
"priority": 1,
"username": "text"
}
],
"version": [
"0 = VmwareESXi",
"11 = v6_5",
"12 = v6_7",
"13 = v7_0",
"14 = v8_0",
"655360 = VmwareESXi_Depr",
"655371 = v6_5_Depr",
"655372 = v6_7_Depr",
"655373 = v7_0_Depr",
"655374 = v8_0_Depr"
]
}POST /api/Provider/vmwareesxi HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 84
{
"name": "text",
"server": "text",
"siteId": 1,
"preferredBrokerId": 1,
"useAllGuests": true
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"adminCredentials": [
{
"enabled": true,
"priority": 1,
"username": "text"
}
],
"version": [
"0 = Scale",
"4 = v8_9",
"5 = v9_1",
"6 = v9_2",
"1310720 = Scale_Depr",
"1310724 = v8_9_Depr",
"1310725 = v9_1_Depr"
]
}POST /api/Provider/scale HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 292
{
"name": "text",
"server": "text",
"siteId": 1,
"vdiAgent": "text",
"providerUsername": "text",
"providerPassword": "text",
"port": 1,
"preferredBrokerId": 1,
"useAllGuests": true,
"scaleVersion": [
"0 = Scale",
"4 = v8_9",
"5 = v9_1",
"6 = v9_2",
"1310720 = Scale_Depr",
"1310724 = v8_9_Depr",
"1310725 = v9_1_Depr"
]
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-14T03:07:50.972Z",
"timeLastMod": "2025-12-14T03:07:50.972Z",
"enabled": true,
"description": "text",
"siteId": 1,
"inheritDefaultAgentSettings": true,
"vdiAgent": "text",
"preferredBrokerId": 1,
"server": "text",
"name": "text",
"type": [
"9 = HyperV",
"10 = VMwareESXi",
"15 = VMwarevCenter",
"16 = HyperVFailover",
"18 = Nutanix",
"20 = ScaleComputing",
"21 = Azure",
"22 = AVD",
"23 = RemotePCStatic",
"24 = RemotePCDynamic",
"25 = AWSEC2"
],
"providerUsername": "text",
"hostPort": 1,
"vdiPort": 1,
"directAddress": "text",
"sessionTimeout": 1,
"sessionLogoffTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"allowDragAndDrop": true,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": true,
"allowFileTransfer": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": true,
"useDefaultPrinterSettings": true,
"removeClientNameFromPrinterName": true,
"removeSessionNumberFromPrinterName": true,
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"enableDriveRedirectionCache": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"useAllGuests": true,
"useDedicatedVDIAgent": true,
"adminCredentials": [
{
"enabled": true,
"priority": 1,
"username": "text"
}
],
"version": [
"1 = RemotePCDynamic",
"1572865 = RemotePCDynamic_Depr"
],
"domainTargetOU": "text",
"subnet": "text"
}POST /api/Provider/remotepcdynamic HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 245
{
"name": "text",
"server": "text",
"siteId": 1,
"vdiAgent": "text",
"providerUsername": "text",
"providerPassword": "text",
"port": 1,
"preferredBrokerId": 1,
"useAllGuests": true,
"remotePCDynamicVersion": [
"1 = RemotePCDynamic",
"1572865 = RemotePCDynamic_Depr"
]
}Retrieve a list of Host Session Processes by Site Id.
Site Id from which to retrieve the Host VM list (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Retrieve the list of all processes for all the VDI Host sessions.
Site ID from which to retrieve the specified Provider server information (optional).
The name of the Provider server for which to retrieve the information (optional).
Success
Unauthorized
Not Found
Retrieve the list of all processes for all the sessions of a specified Provider.
The ID of the Provider server.
Success
Unauthorized
Not Found
Retrieve the list of all processes for a specified VDI Host of a specified Provider.
The ID of the Provider server.
VM ID.
Success
Unauthorized
Not Found
Success
Bad Request
Unauthorized
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Bad Request
Unauthorized
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Bad Request
Unauthorized
Success
Unauthorized
Not Found
GET /api/Provider/VM/AVDHost/Session/Processes 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"avdAgent": "text",
"subnetName": "text",
"session": {
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2025-12-14T03:07:50.972Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2025-12-14T03:07:50.972Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text",
"hostId": "text",
"applications": [
{
"name": "text",
"appName": "text",
"process": "text",
"pid": 1,
"user": "text",
"session": 1,
"serverID": 1
}
]
}
}
]GET /api/Provider/{providerId}/VM/AVDHost/Session/Processes 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"avdAgent": "text",
"subnetName": "text",
"session": {
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2025-12-14T03:07:50.972Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2025-12-14T03:07:50.972Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text",
"hostId": "text",
"applications": [
{
"name": "text",
"appName": "text",
"process": "text",
"pid": 1,
"user": "text",
"session": 1,
"serverID": 1
}
]
}
}
]GET /api/Provider/{providerId}/VM/{id}/AVDHost/Session/Processes 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"avdAgent": "text",
"subnetName": "text",
"session": {
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2025-12-14T03:07:50.972Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2025-12-14T03:07:50.972Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text",
"hostId": "text",
"applications": [
{
"name": "text",
"appName": "text",
"process": "text",
"pid": 1,
"user": "text",
"session": 1,
"serverID": 1
}
]
}
}GET /api/Provider/VM/Host/Process HTTP/1.1
Host:
Accept: */*
[
{
"name": "text",
"appName": "text",
"process": "text",
"pid": 1,
"user": "text",
"session": 1,
"serverID": 1,
"vdiHostId": "text"
}
]GET /api/Provider/{providerId}/VM/Host/Process HTTP/1.1
Host:
Accept: */*
[
{
"name": "text",
"appName": "text",
"process": "text",
"pid": 1,
"user": "text",
"session": 1,
"serverID": 1,
"vdiHostId": "text"
}
]GET /api/Provider/{providerId}/VM/{vmId}/Host/Process HTTP/1.1
Host:
Accept: */*
[
{
"name": "text",
"appName": "text",
"process": "text",
"pid": 1,
"user": "text",
"session": 1,
"serverID": 1,
"vdiHostId": "text"
}
]GET /api/Provider/{providerId}/VM/{vmId}/Host/Process/{pId} HTTP/1.1
Host:
Accept: */*
{
"name": "text",
"appName": "text",
"process": "text",
"pid": 1,
"user": "text",
"session": 1,
"serverID": 1,
"vdiHostId": "text"
}Retrieve a list of Host Sessions by Site Id.
Site Id from which to retrieve the Host VM list (optional).
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Bad Request
Unauthorized
Retrieve a list of Host Sessions by Provider Id.
The Provider Id from which to retrieve the Hosts.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Bad Request
Unauthorized
Retrieve the Host Sessions.
The Provider Id from which to retrieve the Hosts.
The ID of the Host for which to retrieve the status.
The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.
Success
Bad Request
Unauthorized
GET /api/Provider/VM/AVDHost/Session 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"avdAgent": "text",
"subnetName": "text",
"session": {
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2025-12-14T03:07:50.972Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2025-12-14T03:07:50.972Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text",
"hostId": "text"
}
}
]GET /api/Provider/{providerId}/VM/AVDHost/Session 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"avdAgent": "text",
"subnetName": "text",
"session": {
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2025-12-14T03:07:50.972Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2025-12-14T03:07:50.972Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text",
"hostId": "text"
}
}
]GET /api/Provider/{providerId}/VM/{id}/AVDHost/Session 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"
],
"agentVer": "text",
"server": "text",
"serverOS": "text",
"serviceStartTime": "text",
"systemBootTime": "text",
"unhandledExceptions": 1,
"machineId": "text",
"logLevel": [
"0 = Critical",
"1 = Error",
"2 = Warning",
"3 = Standard",
"4 = Extended",
"5 = Verbose",
"-1 = None"
],
"cpuLoad": 1,
"memLoad": 1,
"diskRead": 1,
"diskWrite": 1,
"enabled": true,
"hostIP": "text",
"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"
],
"assignment": [
"1 = User",
"2 = Device"
],
"user": "text",
"disks": "text",
"avdAgent": "text",
"subnetName": "text",
"session": {
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2025-12-14T03:07:50.972Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2025-12-14T03:07:50.972Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text",
"hostId": "text"
}
}