Horizon Server API Operations Index

Horizon Server API Operations Index

All available Horizon Server API Operations

Auth

Logs in a user. Returns access token and refresh token.

Logs out a user.

Refresh Access Token

Refreshes access token from refresh token.

Config

Create IC Domain Account

Creates instant clone domain account.

Create IM Asset

Creates image management asset.

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.

Create IM Stream

Creates image management stream.

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.

Creates image management tag.

Creates one or more image management tags. Each of the index of result in the response, correspond to the index of the original tag.

Create IM Version

Creates image management version.

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.

Delete IC Domain Account

Deletes instant clone domain account.

Delete IM Asset

Deletes image management asset.

Delete IM Stream

Deletes image management stream.

Deletes image management tag.

Delete IM Version

Deletes image management version.

Get Environment

Retrieves the environment settings.

Get Environment V2

Retrieves the environment settings.

Get Feature Settings

Retrieves the feature settings.

Get General Settings

Retrieves the general settings.

Get IC Domain Account

Gets instant clone domain account.

Gets image management asset.

Gets image management stream.

Gets image management tag.

Gets image management version.

Get Security Settings

Retrieves the security settings.

Retrieves the configuration settings.

List IC Domain Accounts

Lists instant clone domain accounts of the environment.

Lists image management assets.

List IM Streams

Lists image management streams.

Lists image management tags.

List IM Versions

Lists image management versions.

List RCX Servers

Lists RCX servers of the cluster.

Lists Virtual Centers configured in the environment.

List VC Info V2

Lists Virtual Centers configured in the environment.

Register RCX Client

Registers the RCX client

Unregister RCX Client

Unregisters the given RCX Client

Update Feature Settings

Updates the feature settings.

Update General Settings

Updates the general settings.

Update IC Domain Account

Updates instant clone domain account.

Update IM Asset

Updates image management asset.

Update IM Stream

Updates image management stream.

Updates image management tag.

Update IM Version

Updates image management version.

Update RCX Client

Updates the given RCX client.

Update Security Settings

Updates the security settings.

Update Settings

Updates the configuration settings.

Entitlements

Bulk Create Application Pool Entitlements

Create the bulk entitlements for a set of application pools

Bulk Create Desktop Pool Entitlements

Create the bulk entitlements for a set of desktop pools

Bulk Create GAE Entitlements

Create the bulk entitlements for a set of Global Application Entitlements

Bulk Create GDE Entitlements

Create the bulk entitlements for a set of Global Desktop Entitlements

Bulk Delete Application Pool Entitlements

Delete the bulk entitlements for a set of application pools

Bulk Delete Desktop Pool Entitlements

Delete the bulk entitlements for a set of desktop pools

Bulk Delete GAE Entitlements

Delete the bulk entitlements for a set of Global Application Entitlements

Bulk Delete GDE Entitlements

Delete the bulk entitlements for a set of Global Desktop Entitlements

Get Application Pool Entitlements

Returns the IDs of users or groups entitled to a given application pool.

Get Desktop Pool Entitlements

Returns the IDs of users or groups entitled to a given desktop pool.

Get GAE Entitlement

Gets the user or group entitlements for a Global Application Entitlement.

Get GDE Entitlement

Gets the user or group entitlements for a Global Desktop Entitlement.

List Application Pool Entitlements

Lists the entitlements for Application Pools in the environment.

List Desktop Pool Entitlements

Lists the entitlements for Desktop Pools in the environment.

List GAE Entitlements

Lists the user or group entitlements for Global Application Entitlements in the environment.

List GDE Entitlements

Lists the user or group entitlements for Global Desktop Entitlements in the environment.

External

Change User Password

Changes the password of AD User

Get AD User Or Group Info

Get information related to AD User or Group

List AD Domains

Lists information related to AD Domains of the environment.

List AD User Or Group Summary

Lists AD users or groups information.

List Base Snapshots

Lists all the VM snapshots from the vCenter for a given VM.

Lists all the VMs from a vCenter or a datacenter in that vCenter which may be suitable as snapshots for instant/linked clone desktop or farm creation.

List Customization Specs

Lists all the customization specifications from the vCenter.

List Datacenters

Lists all the datacenters of a vCenter.

List Datastore Paths

Lists all the folder paths within a Datastore from vCenter.

Lists all the datastoress from the vCenter for the given host or cluster.

List Hosts Or Clusters

Lists all the hosts or clusters of the datacenter.

List Network Interface Cards

Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.

List Network Labels

Retrieves all network labels on the given host or cluster

List Resource Pools

Lists all the resource pools from the vCenter for the given host or cluster.

List Virtual Machines

Lists all the VMs from a vCenter.

List VM Folders

Lists all the VM folders from the vCenter for the given datacenter.

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.

Validate AD User Encrypted Credentials

Validates the encrypted credentials of AD User

Federation

Create Home Sites

Creates the given home sites in the pod federation.

Creates a site.

Delete Home Sites

Deletes the given home sites from the pod federation.

Deletes a site.

Removes a pod from Cloud Pod Federation.

Retrieves a given home site in the pod federation.

Retrieves a given pod from the pod federation.

Get Pod Assignment

Retrieves a given pod assignment from the pod federation.

Get Pod Endpoint

Retrieves pod endpoint details for the given pod endpoint id in the given pod.

Get Pod Federation

Retrieves the pod federation details.

Retrives a given site.

Retrieves the information for a given task.

Initialize Cloud Pod Federation.

Join Cloud Pod Federation.

List Home Sites

Lists all the home sites in the pod federation.

List Pod Assignments

Lists all the pod assignments in the pod federation.

List Pod Endpoint

Lists all the pod endpoints for the given pod.

Lists all the pods in the pod federation.

Lists all the sites in the pod federation.

Lists all the CPA tasks in the pod federation.

Resolve Home Sites

Resolves home sites for a user in the pod federation.

Uninitialize CPA

Uninitialize Cloud Pod Federation.

Unjoin from Cloud Pod Federation.

Updates the given pod in the pod federation.

Update Pod Federation

Updates a Pod Federation.

Updates a site.

Inventory

Add Local Application Pools To GAE

Adds Local Application Pools to Global Application Entitlement.

Add Local Desktop Pools To GDE

Adds Local Desktop Pools to Global Desktop Entitlement.

Adds machines to the given manual desktop pool.

Add Machines By Name

Adds the named machines to the given desktop pool.

Assign Machine Aliases

Assigns the specified aliases to the assigned users of the machine.

Assigns the specified users to the machine.

Cancel Desktop Pool Task

Cancels the instant clone desktop pool push image task.

Cancel Scheduled Push Image

Request the cancellation of the current scheduled push image operation on the specified instant clone desktop pool.

Create Application Pool

Creates an application pool.

Create Global Desktop Entitlement

Creates a Global Desktop Entitlement.

Delete Application Pool

Deletes application pool.

Deletes the machine.

Delete Machines

Deletes the specified machines.

Delete Physical Machine

Deletes the Physical Machine.

Delete RDS Server

Deletes the RDS Server.

Disconnect Sessions

Disconnects user sessions

Enter Maintenance

Puts the machines into maintenance mode.

Exit Maintenance

Puts the machines out of maintenance mode.

Get Application Icon

Gets application icon.

Get Application Pool

Gets application pool.

Get Application Pool V2

Gets application pool.

Get Desktop Pool

Gets the Desktop Pool information.

Get Desktop Pool Task

Gets the task information on the desktop pool.

Get Desktop Pool V2

Gets the desktop pool information.

Get Desktop Pool V3

Gets the desktop pool information.

Gets the Farm information.

Get Global Application Entitlement

Gets the Global Application Entitlement in the environment.

Get Global Desktop Entitlement

Gets the Global Desktop Entitlement in the environment.

Gets the Machine information.

Gets the Machine information.

Get Physical Machine

Gets the Physical Machine information.

Gets the RDS Server information.

Get Session Info

Gets the Session information.

List Application Icons

Lists the application icons for the given application pool.

List Application Pools

Lists the application pools in the environment.

List Application Pools V2

Lists the application pools in the environment.

List Compatible Local Application Pools

Lists Local Application Pools which are compatible with Global Application Entitlement.

List Compatible Local Desktop Pools

Lists Local Desktop Pools which are compatible with Global Desktop Entitlement.

List Desktop Pools

Lists the Desktop Pools in the environment.

List Desktop Pools V2

Lists the desktop pools in the environment.

List Desktop Pools V3

Lists the desktop pools in the environment.

List Desktop Pool Tasks

Lists the tasks on the desktop pool.

Lists the Farms in the environment.

List Global Application Entitlements

Lists the Global Application Entitlements in the environment.

List Global Desktop Entitlements

Lists the Global Desktop Entitlements in the environment.

List Installed Applications On Desktop Pool

Lists the installed applications on the given desktop pool.

List Installed Applications On Farm

Lists the installed applications on the given farm.

List Local Application Pools

Lists Local Application Pools which are assigned to Global Application Entitlement.

List Local Desktop Pools

Lists Local Desktop Pools which are assigned to Global Desktop Entitlement.

Lists the Machines in the environment.

List Machines V2

Lists the Machines in the environment.

List Physical Machines

Lists the Physical Machines in the environment.

List RDS Servers

Lists the RDS Servers in the environment.

List Session Info

Lists the Session information in the environment.

Log Off Sessions

Logs off user sessions, if they are not locked.

Rebuild Machines

Rebuilds the specified machines.

Recover Machines

Recovers the specified machines.

Recover RDS Servers

Recovers the specified RDS Servers.

Register Physical Machine

Registers the Physical Machine.

Register RDS Server

Registers the RDS Server.

Remove Local Application Pools From GAE

Removes Local Application Pools from Global Application Entitlement.

Remove Local Desktop Pools From GDE

Removes Local Desktop Pools from Global Desktop Entitlement.

Remove Machines

Removes machines from the given manual desktop pool.

Resets the specified machines.

Resets machine of user sessions. The machine must be managed by Virtual Center and the session cannot be an application or an RDS desktop session.

Restart Machines

Restarts the specified machines.

Restart Sessions

Restarts machine of user sessions. The machine must be managed by Virtual Center and the session cannot be an application or an RDS desktop session.

Schedule Push Image

Schedule/reschedule a request to update the image in an instant clone desktop pool.

Send Message To Sessions

Sends the message to user sessions

Unassign Machine Aliases

Un-assigns the aliases for the specified users from the machine.

Un-assigns the specified users from the machine.

Update Application Pool

Updates application pool.

Update RDS Server

Updates the RDS Server.

Monitor

Get Connection Server Monitor Info V2

Gets monitoring information related to Connection Server.

Get Event Database Monitor

Returns monitoring information related to Event database of the environment.

Get Farm Monitor Info

Gets monitoring information related to farm.

Get Gateway Monitor Info

Gets monitoring information related to a Gateway.

Get Pod Monitor Info V2

Gets monitoring information related to the remote pod.

Get RDS Server Monitors

Gets monitoring information related to RDS Server.

Get SAML Authenticator Monitor Info

Gets Monitoring Information related to a SAML Authenticator

Get True SSO Monitor Info

Gets monitoring information related to a True SSO connector.

Get View Composer By VC Id

View Composer is no longer supported from Horizon version 2012 onwards.

Get Virtual Center Monitor Info

Gets monitoring information related to Virtual Center.

List AD Domain Monitor Infos V2

Lists monitoring information related to AD Domains of the environment.

List AD Domain Monitors

Lists monitoring information related to AD Domains of the environment.

List Connection Server Monitors

Lists monitoring information related to Connection Servers of the environment.

List Connection Server Monitors V2

Lists monitoring information related to Connection Servers of the environment.

List Desktop Pool Metrics

Lists metrics of desktop pools (except RDS desktop pools).

List Farm Monitors

Lists monitoring information related to Farms of the environment.

List Gateway Monitor Info V1

Lists monitoring information related to Gateways registered in the environment.

List Gateway Monitor Info V2

Lists monitoring information related to Gateways registered in the environment.

List Pod Monitor Infos V1

Lists monitoring information related to the remote pods.

List Pod Monitor Infos V2

Lists monitoring information related to the remote pods.

List RDS Server Monitors

Lists monitoring information related to RDS Servers of the environment.

List SAML Authenticator Monitors V1

Lists monitoring information related to SAML Authenticators of the environment.

List SAML Authenticator Monitors V2

Lists monitoring information related to SAML Authenticators of the environment.

List True SSO Monitor Infos

Lists monitoring information related to True SSO connectors.

List View Composer Monitors V1

View Composer is no longer supported from Horizon version 2012 onwards.

List View Composer Monitors V2

View Composer is no longer supported from Horizon version 2012 onwards.

List Virtual Center Monitors

Lists monitoring information related to Virtual Centers of the environment.

List Virtual Center Monitors V2

Lists monitoring information related to Virtual Centers of the environment.