Horizon Server API Operations Index
All available Horizon Server API Operations
Auth
POST
Key Agreement
Uses Diffie-Hellman algorithm to achieve encryption key agreement between client and server, which then can be used to encrypt and decrypt sensitive information.
POST
Login User
Logs in a user. Returns access token and refresh token.
POST
Logout User
Logs out a user.
POST
Refresh Access Token
Refreshes access token from refresh token.
Config
POST
Create Federation Access Group
Creates federation access group.
POST
Create IC Domain Account
Creates instant clone domain account.
POST
Create IM Asset
Creates image management asset.
POST
Create IM Assets
Creates one or more image management assets. Each of the index of result in the response, correspond to the index of the original asset.
POST
Create IM Stream
Creates image management stream.
POST
Create IM Streams
Creates one or more image management streams. Each of the index of result in the response, correspond to the index of the original stream.
POST
Create IM Tag
Creates image management tag.
POST
Create IM Tags
Creates one or more image management tags. Each of the index of result in the response, correspond to the index of the original tag.
POST
Create IM Version
Creates image management version.
POST
Create IM Versions
Creates one or more image management versions. Each of the index of result in the response, correspond to the index of the original version.
POST
Create JWT Authenticator
Creates a JWT authenticator.
POST
Create Local Access Group
Creates local access group.
POST
Create Permissions
Creates permissions in bulk.
POST
Create Role
Creates a role.
DELETE
Delete Federation Access Group
Deletes a federation access group.
DELETE
Delete IC Domain Account
Deletes instant clone domain account.
DELETE
Delete IM Asset
Deletes image management asset.
DELETE
Delete IM Stream
Deletes image management stream.
DELETE
Delete IM Tag
Deletes image management tag.
DELETE
Delete IM Version
Deletes image management version.
DELETE
Delete JWT Authenticator
Deletes the given JWT authenticator.
DELETE
Delete Local Access Group
Deletes a local access group.
DELETE
Delete Permissions
Deletes permissions in bulk.
DELETE
Delete Role
Deletes a role.
GET
Get Connection Server
Retrieves information about a connection server.
GET
Get Environment
Retrieves the environment settings.
GET
Get Environment V2
Retrieves the environment settings.
GET
Get Feature Settings
Retrieves the feature settings.
GET
Get Federation Access Group
Retrieves a federation access group.
GET
Get Federation Access Group V2
Retrieves a federation access group.
GET
Get General Settings
Retrieves the general settings.
GET
Get General Settings V2
Retrieves the general settings.
GET
Get IC Domain Account
Gets instant clone domain account.
GET
Get IM Asset
Gets image management asset.
GET
Get IM Stream
Gets image management stream.
GET
Get IM Tag
Gets image management tag.
GET
Get IM Version
Gets image management version.
GET
Get JWT Authenticator
Retrieves information about the given JWT authenticator.
GET
Get Local Access Group
Retrieves a local access group.
GET
Get Local Access Group V2
Retrieves a local access group.
GET
Get Permission
Retrieves a permission.
GET
Get Role
Retrieves a role.
GET
Get Security Settings
Retrieves the security settings.
GET
Get Settings
Retrieves the configuration settings.
GET
Get Settings V2
Retrieves the configuration settings.
GET
List Connection Servers
Lists the connection servers.
GET
List Federation Access Groups
Lists all federation access groups.
GET
List Federation Access Groups V2
Lists all federation access groups.
GET
List IC Domain Accounts
Lists instant clone domain accounts of the environment.
GET
List IM Assets
Lists image management assets.
GET
List IM Streams
Lists image management streams.
GET
List IM Tags
Lists image management tags.
GET
List IM Versions
Lists image management versions.
GET
List JWT Authenticators
Lists the configured JWT authenticators.
GET
List Local Access Groups
Lists all local access groups.
GET
List Local Access Groups V2
Lists all local access groups.
GET
List Permissions
Lists all permissions.
GET
List RCX Servers
Lists RCX servers of the cluster.
GET
List Roles
Lists all roles.
GET
List Selectable Privileges
Lists all selectable privileges.
GET
List VC Info
Lists Virtual Centers configured in the environment.
GET
List VC Info V2
Lists Virtual Centers configured in the environment.
POST
Mark Datastores For Archival
Sets archival datastore paths for the vCenter.
POST
Register RCX Client
Registers the RCX client
DELETE
Unregister RCX Client
Unregisters the given RCX Client
PUT
Update Connection Server
Updates the settings of the given Connection Server.
PUT
Update Feature Settings
Updates the feature settings.
PUT
Update General Settings
Updates the general settings.
PUT
Update General Settings V2
Updates the general settings.
PUT
Update IC Domain Account
Updates instant clone domain account.
PUT
Update IM Asset
Updates image management asset.
PUT
Update IM Stream
Updates image management stream.
PUT
Update IM Tag
Updates image management tag.
PUT
Update IM Version
Updates image management version.
PUT
Update JWT Authenticator
Updates the given JWT authenticator.
PUT
Update RCX Client
Updates the given RCX client.
PUT
Update Role
Updates a role.
PUT
Update Security Settings
Updates the security settings.
PUT
Update Settings
Updates the configuration settings.
PUT
Update Settings V2
Updates the configuration settings.
Entitlements
POST
Bulk Create Application Pool Entitlements
Create the bulk entitlements for a set of application pools
POST
Bulk Create Desktop Pool Entitlements
Create the bulk entitlements for a set of desktop pools
POST
Bulk Create GAE Entitlements
Create the bulk entitlements for a set of Global Application Entitlements
POST
Bulk Create GDE Entitlements
Create the bulk entitlements for a set of Global Desktop Entitlements
DELETE
Bulk Delete Application Pool Entitlements
Delete the bulk entitlements for a set of application pools
DELETE
Bulk Delete Desktop Pool Entitlements
Delete the bulk entitlements for a set of desktop pools
DELETE
Bulk Delete GAE Entitlements
Delete the bulk entitlements for a set of Global Application Entitlements
DELETE
Bulk Delete GDE Entitlements
Delete the bulk entitlements for a set of Global Desktop Entitlements
GET
Get Application Pool Entitlements
Returns the IDs of users or groups entitled to a given application pool.
GET
Get Desktop Pool Entitlements
Returns the IDs of users or groups entitled to a given desktop pool.
GET
Get GAE Entitlement
Gets the user or group entitlements for a Global Application Entitlement.
GET
Get GDE Entitlement
Gets the user or group entitlements for a Global Desktop Entitlement.
GET
List Application Pool Entitlements
Lists the entitlements for Application Pools in the environment.
GET
List Desktop Pool Entitlements
Lists the entitlements for Desktop Pools in the environment.
GET
List GAE Entitlements
Lists the user or group entitlements for Global Application Entitlements in the environment.
GET
List GDE Entitlements
Lists the user or group entitlements for Global Desktop Entitlements in the environment.
External
POST
Add Auxiliary Accounts
Add auxiliary accounts to the untrusted domain
GET
Audit Events Extended Attributes
Get extended attributes of audit events
POST
Bind
Bind untrusted domain to the connection server.
POST
Bulk Hold User Or Group
Put users on hold.
POST
Bulk Release Hold User Or Group
Release users from hold.
POST
Change User Password
Changes the password of AD User
POST
Compute Space Requirements
Computes the datastore space requirements for inventory resources.
POST
Delete Auxiliary Accounts
Specification to delete auxiliary accounts from the untrusted domain
GET
Get AD User Or Group Info
Get information related to AD User or Group
GET
List AD Containers
List active directory containers for a specific domain.
GET
List AD Domains
Lists information related to AD Domains of the environment.
GET
List AD Domains V2
Lists information related to AD Domains of the environment.
GET
List AD Domains V3
Lists information related to AD Domains of the environment.
GET
List AD User Or Group Summary
Lists AD users or groups information.
GET
List Audit Events
Lists the audit events.
GET
List Base Snapshots
Lists all the VM snapshots from the vCenter for a given VM.
GET
List Base Snapshots V2
Lists all the VM snapshots from the vCenter for a given VM.
GET
List Base V Ms
Lists all the VMs from a vCenter or a datacenter in that vCenter which may be suitable as snapshots for instant clone desktop pool or farm creation.
GET
List Customization Specs
Lists all the customization specifications from the vCenter.
GET
List Datacenters
Lists all the datacenters of a vCenter.
GET
List Datastore Clusters
Lists all the datastore clusters from the vCenter for the given host or cluster.
GET
List Datastore Paths
Lists all the folder paths within a Datastore from vCenter.
GET
Listdatastores
Lists all the datastores from the vCenter for the given host or cluster.
GET
List Held Users Or Groups
List information related to Held Users.
GET
List Hosts Or Clusters
Lists all the hosts or clusters of the datacenter.
GET
List Network Interface Cards
Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.
GET
List Network Interface Cards V2
Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.
GET
List Network Labels
Retrieves all network labels on the given host or cluster
GET
List Resource Pools
Lists all the resource pools from the vCenter for the given host or cluster.
GET
List Virtual Machines
Lists all the VMs from a vCenter.
GET
List VM Folders
Lists all the VM folders from the vCenter for the given datacenter.
GET
List VM Templates
Lists all the VM templates from a vCenter or a datacenter for the given vCenter which may be suitable for full clone desktop pool creation.
POST
Unbind
Unbind untrusted domain from the connection server.
POST
Update
Updates untrusted domain.
POST
Update Auxiliary Accounts
Update auxiliary accounts of the untrusted domain
POST
Validate AD User Encrypted Credentials
Validates the encrypted credentials of AD User
Federation
POST
Create Home Sites
Creates the given home sites in the pod federation.
POST
Create Site
Creates a site.
DELETE
Delete Home Sites
Deletes the given home sites from the pod federation.
DELETE
Delete Site
Deletes a site.
POST
Eject Pod
Removes a pod from Cloud Pod Federation.
GET
Get Home Site
Retrieves a given home site in the pod federation.
GET
Get Pod
Retrieves a given pod from the pod federation.
GET
Get Pod Assignment
Retrieves a given pod assignment from the pod federation.
GET
Get Pod Endpoint
Retrieves pod endpoint details for the given pod endpoint id in the given pod.
GET
Get Pod Federation
Retrieves the pod federation details.
GET
Get Site
Retrives a given site.
GET
Get Task
Retrieves the information for a given task.
POST
Initialize CPA
Initialize Cloud Pod Federation.
POST
Join CPA
Join Cloud Pod Federation.
GET
List Home Sites
Lists all the home sites in the pod federation.
GET
List Pod Assignments
Lists all the pod assignments in the pod federation.
GET
List Pod Endpoint
Lists all the pod endpoints for the given pod.
GET
List Pods
Lists all the pods in the pod federation.
GET
List Sites
Lists all the sites in the pod federation.
GET
List Tasks
Lists all the CPA tasks in the pod federation.
POST
Resolve Home Sites
Resolves home sites for a user in the pod federation.
POST
Uninitialize CPA
Uninitialize Cloud Pod Federation.
POST
Unjoin CPA
Unjoin from Cloud Pod Federation.
PUT
Update Pod
Updates the given pod in the pod federation.
PUT
Update Pod Federation
Updates a Pod Federation.
PUT
Update Site
Updates a site.
Inventory
POST
Add Custom Icon
Associates a custom icon to the application pool.
POST
Add Local Application Pools To GAE
Adds Local Application Pools to Global Application Entitlement.
POST
Add Local Desktop Pools To GDE
Adds Local Desktop Pools to Global Desktop Entitlement.
POST
Add Machines
Adds machines to the given manual desktop pool.
POST
Add Machines By Name
Adds the named machines to the given desktop pool.
POST
Add Rds Servers
Add RDS servers to the specified manual farm.
POST
Archive Machines
Initiates machine archival process
POST
Assign Machine Aliases
Assigns the specified aliases to the assigned users of the machine.
POST
Assign Users
Assigns the specified users to the machine.
POST
Cancel Desktop Pool Task
Cancels the instant clone desktop pool push image task.
POST
Cancel Scheduled Maintenance
Requests cancellation of the current scheduled maintenance on the specified Instant Clone farm.
POST
Cancel Scheduled Push Image
Request the cancellation of the current scheduled push image operation on the specified instant clone desktop pool.
POST
Check Application Pool Name Availability
Checks if the given name is available for application pool creation.
POST
Check Desktop Pool Name Availability
Checks if the given name is available for desktop pool creation.
POST
Check Farm Name Availability
Checks if the given name is available for farm creation.
POST
Check Machine Prefix Availability
Checks if the given prefix is available for machine creation.
POST
Check RDS Server Prefix Availability
Checks if the given prefix is available for RDS Server creation.
POST
Create Application Icon
Creates an application icon.
POST
Create Application Pool
Creates an application pool.
POST
Create Application Pool V2
Creates an application pool.
POST
Create Desktop Pool
Creates a desktop pool.
POST
Create Desktop Pool V2
Creates a desktop pool.
POST
Create Farm
Creates a farm.
POST
Create Farm V2
Creates a farm.
POST
Create Farm V3
Creates a farm.
POST
Create Global Application Entitlement
Creates a Global Application Entitlement.
POST
Create Global Desktop Entitlement
Creates a Global Desktop Entitlement.
POST
Create Global Desktop Entitlement V2
Creates a Global Desktop Entitlement.
DELETE
Delete Application Pool
Deletes application pool.
DELETE
Delete Desktop Pool
Deletes a desktop pool.
DELETE
Delete Farm
Deletes a farm.
DELETE
Delete Global Application Entitlement
Deletes a Global Application Entitlement.
DELETE
Delete Global Desktop Entitlement
Deletes a Global Desktop Entitlement.
DELETE
Delete Machine
Deletes the machine.
DELETE
Delete Machines
Deletes the specified machines.
DELETE
Delete Physical Machine
Deletes the Physical Machine.
DELETE
Delete RDS Server
Deletes the RDS Server.
POST
Desktop Pool Apply Image
Applies the pending image or the current image to selected machines in the desktop pool.
POST
Desktop Pool Promote Pending Image
Promotes pending image to current image in the desktop pool.
POST
Disconnect Global Sessions
Disconnects global sessions in the environment.
POST
Disconnect Sessions
Disconnects locally resourced user sessions.
POST
Enter Maintenance
Puts the machines into maintenance mode.
POST
Exit Maintenance
Puts the machines out of maintenance mode.
POST
Farm Apply Image
Applies the pending image or the current image to selected RDS servers in the farm.
POST
Farm Promote Pending Image
Promotes pending image to current image in the farm.
GET
Get Application Icon
Gets application icon.
GET
Get Application Pool
Gets application pool.
GET
Get Application Pool V2
Gets application pool.
GET
Get Application Pool V3
Gets application pool.
GET
Get Desktop Pool
Gets the Desktop Pool information.
GET
Get Desktop Pool Task
Gets the task information on the desktop pool.
GET
Get Desktop Pool V2
Gets the desktop pool information.
GET
Get Desktop Pool V3
Gets the desktop pool information.
GET
Get Desktop Pool V4
Gets the desktop pool information.
GET
Get Desktop Pool V5
Gets the desktop pool information.
GET
Get Desktop Pool V6
Gets the desktop pool information.
GET
Get Farm
Gets the Farm information.
GET
Get Farm V2
Gets the Farm information.
GET
Get Farm V3
Gets the Farm information.
GET
Get Farm V4
Gets the Farm information.
GET
Get Global Application Entitlement
Gets the Global Application Entitlement in the environment.
GET
Get Global Application Entitlement V2
Gets the Global Application Entitlement in the environment.
GET
Get Global Desktop Entitlement
Gets the Global Desktop Entitlement in the environment.
GET
Get Global Desktop Entitlement V2
Gets the Global Desktop Entitlement in the environment.
GET
Get Machine
Gets the Machine information.
GET
Get Machine V2
Gets the Machine information.
GET
Get Machine V3
Gets the Machine information.
GET
Get Physical Machine
Gets the Physical Machine information.
GET
Get Physical Machine V2
Gets the Physical Machine information.
GET
Get RDS Server
Gets the RDS Server information.
GET
Get Session Info
Gets the Session information for locally resourced session.
GET
List Application Icons
Lists the application icons for the given application pool.
GET
List Application Pools
Lists the application pools in the environment.
GET
List Application Pools V2
Lists the application pools in the environment.
GET
List Application Pools V3
Lists the application pools in the environment.
GET
List Compatible Backup GA Es
Lists the Global Application Entitlements that can be associated as backup Global Application Entitlement.
GET
List Compatible Backup GD Es
Lists the Global Desktop Entitlements that can be associated as backup Global Desktop Entitlement.
GET
List Compatible Local Application Pools
Lists Local Application Pools which are compatible with Global Application Entitlement.
GET
List Compatible Local Desktop Pools
Lists Local Desktop Pools which are compatible with Global Desktop Entitlement.
GET
List Desktop Pools
Lists the Desktop Pools in the environment.
GET
List Desktop Pools V2
Lists the desktop pools in the environment.
GET
List Desktop Pools V3
Lists the desktop pools in the environment.
GET
List Desktop Pools V4
Lists the desktop pools in the environment.
GET
List Desktop Pools V5
Lists the desktop pools in the environment.
GET
List Desktop Pools V6
Lists the desktop pools in the environment.
GET
List Desktop Pool Tasks
Lists the tasks on the desktop pool.
GET
List Farms
Lists the Farms in the environment.
GET
List Farms V2
Lists the Farms in the environment.
GET
List Farms V3
Lists the Farms in the environment.
GET
List Farms V4
Lists the Farms in the environment.
GET
List Global Application Entitlements
Lists the Global Application Entitlements in the environment.
GET
List Global Application Entitlements V2
Lists the Global Application Entitlements in the environment.
GET
List Global Desktop Entitlements
Lists the Global Desktop Entitlements in the environment.
GET
List Global Desktop Entitlements V2
Lists the Global Desktop Entitlements in the environment.
GET
List Installed Applications On Desktop Pool
Lists the installed applications on the given desktop pool.
GET
List Installed Applications On Farm
Lists the installed applications on the given farm.
GET
List Local Application Pools
Lists Local Application Pools which are assigned to Global Application Entitlement.
GET
List Local Desktop Pools
Lists Local Desktop Pools which are assigned to Global Desktop Entitlement.
GET
List Machines
Lists the Machines in the environment.
GET
List Machines V2
Lists the Machines in the environment.
GET
List Machines V3
Lists the Machines in the environment.
GET
List Physical Machines
Lists the Physical Machines in the environment.
GET
List Physical Machines V2
Lists the Physical Machines in the environment.
GET
List RDS Servers
Lists the RDS Servers in the environment.
GET
List Session Info
Lists the locally resourced Sessions in the environment
POST
Log Off Global Sessions
Logs off global sessions in the environment.
POST
Log Off Sessions
Logs off locally resourced user sessions, if they are not locked.
POST
Pause Desktop Pool Task
Pause the instant clone desktop pool push image task.
GET
Query Global Sessions
Lists global sessions in the environment for the given user, pod or brokering pod.
POST
Rebuild Machines
Rebuilds the specified machines.
POST
Recover Machines
Recovers the specified machines.
POST
Recover RDS Servers
Recovers the specified RDS Servers.
POST
Register Physical Machine
Registers the Physical Machine.
POST
Register RDS Server
Registers the RDS Server.
POST
Remove Custom Icon
Removes the associated custom icon from the application pool.
DELETE
Remove Local Application Pools From GAE
Removes Local Application Pools from Global Application Entitlement.
DELETE
Remove Local Desktop Pools From GDE
Removes Local Desktop Pools from Global Desktop Entitlement.
POST
Remove Machines
Removes machines from the given manual desktop pool.
POST
Remove Rds Servers
Remove RDS servers from the specified farm.
POST
Reset Global Sessions
Resets machines of global sessions in the environment.
POST
Reset Machines
Resets the specified machines.
POST
Reset Sessions
Resets machine of locally resourced user sessions. The machine must be managed by Virtual Center and the session cannot be an application or an RDS desktop session.
POST
Restart Global Sessions
Restarts machines of global sessions in the environment.
POST
Restart Machines
Restarts the specified machines.
POST
Restart Sessions
Restarts machine of locally resourced user sessions. The machine must be managed by Virtual Center and the session cannot be an application or an RDS desktop session.
POST
Resume Desktop Pool Task
Resume the instant clone desktop pool push image task.
POST
Schedule Maintenance
Creates maintenance schedule for the specified farm.
POST
Schedule Maintenance V2
Creates maintenance schedule for the specified farm.
POST
Schedule Push Image
Schedule/reschedule a request to update the image in an instant clone desktop pool.
POST
Schedule Push Image V2
Schedule/reschedule a request to update the image in an instant clone desktop pool.
POST
Send Message To Global Sessions
Sends message to global sessions in the environment.
POST
Send Message To Sessions
Sends the message to locally resourced user sessions.
POST
Unassign Machine Aliases
Un-assigns the aliases for the specified users from the machine.
POST
Unassign Users
Un-assigns the specified users from the machine.
PUT
Update Application Pool
Updates application pool.
PUT
Update Application Pool V2
Updates application pool.
PUT
Update Desktop Pool
Updates desktop pool.
PUT
Update Farm
Updates farm.
PUT
Update Farm V2
Updates farm.
PUT
Update Farm V3
Updates farm.
PUT
Update Global Application Entitlement
Updates a Global Application Entitlement.
PUT
Update Global Desktop Entitlement
Updates a Global Desktop Entitlement.
PUT
Update RDS Server
Updates the RDS Server.
POST
Validate Installed Applications On Desktop Pool
Validates that each application in the given list is installed on the machines belonging to the specified desktop pool.
POST
Validate Installed Applications On Farm
Validates that each application in the given list is installed on the RDS Servers belonging to the specified Farm.
POST
Validate Specified Names
Validates manually specified virtual machines. Ensures machine and user names are valid and aren't duplicated in the given desktop pool.
Monitor
GET
Get Connection Server Monitor Info V2
Gets monitoring information related to Connection Server.
GET
Get Event Database Monitor
Returns monitoring information related to Event database of the environment.
GET
Get Farm Monitor Info
Gets monitoring information related to farm.
GET
Get Gateway Monitor Info
Gets monitoring information related to a Gateway.
GET
Get Pod Monitor Info V2
Gets monitoring information related to the remote pod.
GET
Get RDS Server Monitors
Gets monitoring information related to RDS Server.
GET
Get SAML Authenticator Monitor Info
Gets Monitoring Information related to a SAML Authenticator
GET
Get True SSO Monitor Info
Gets monitoring information related to a True SSO connector.
GET
Get View Composer By VC Id
View Composer is no longer supported from Horizon version 2012 onwards.
GET
Get Virtual Center Monitor Info
Gets monitoring information related to Virtual Center.
GET
List AD Domain Monitor Infos V2
Lists monitoring information related to AD Domains of the environment.
GET
List AD Domain Monitor Infos V3
Lists monitoring information related to AD Domains of the environment.
GET
List AD Domain Monitors
Lists monitoring information related to AD Domains of the environment.
GET
List Connection Server Monitors
Lists monitoring information related to Connection Servers of the environment.
GET
List Connection Server Monitors V2
Lists monitoring information related to Connection Servers of the environment.
GET
List Desktop Pool Metrics
Lists metrics of desktop pools (except RDS desktop pools).
GET
List Farm Monitors
Lists monitoring information related to Farms of the environment.
GET
List Gateway Monitor Info V1
Lists monitoring information related to Gateways registered in the environment.
GET
List Gateway Monitor Info V2
Lists monitoring information related to Gateways registered in the environment.
GET
List Pod Monitor Infos V1
Lists monitoring information related to the remote pods.
GET
List Pod Monitor Infos V2
Lists monitoring information related to the remote pods.
GET
List RDS Server Monitors
Lists monitoring information related to RDS Servers of the environment.
GET
List SAML Authenticator Monitors V1
Lists monitoring information related to SAML Authenticators of the environment.
GET
List SAML Authenticator Monitors V2
Lists monitoring information related to SAML Authenticators of the environment.
GET
List True SSO Monitor Infos
Lists monitoring information related to True SSO connectors.
GET
List View Composer Monitors V1
View Composer is no longer supported from Horizon version 2012 onwards.
GET
List View Composer Monitors V2
View Composer is no longer supported from Horizon version 2012 onwards.
GET
List Virtual Center Monitors
Lists monitoring information related to Virtual Centers of the environment.
GET
List Virtual Center Monitors V2
Lists monitoring information related to Virtual Centers of the environment.