Providers
Retrieve a list of Provider settings.
Site ID for which to retrieve Provider settings (optional)
Filter the result by Provider name (optional)
GET /api/Provider HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-05T10:32:14.296Z",
"timeLastMod": "2025-07-05T10:32:14.296Z",
"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
}
]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.
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-07-05T10:32:14.296Z",
"timeLastMod": "2025-07-05T10:32:14.296Z",
"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
}Retrieve a specific Provider by ID.
Provider ID
GET /api/Provider/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-05T10:32:14.296Z",
"timeLastMod": "2025-07-05T10:32:14.296Z",
"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
}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
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"
]
}No content
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.
DELETE /api/Provider/{id} HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?