Horizon Server API Operations Index

All available Horizon Server API Operations

Auth

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 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.

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.

GET

Get Environment Using GET

Retrieves the environment settings.

GET

Get Feature Settings Using GET

Retrieves the feature settings.

GET

Get General Settings Using GET

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 Security Settings Using GET

Retrieves the security settings.

GET

Get Settings Using GET

Retrieves the configuration settings.

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 RCX Servers

Lists RCX servers of the cluster.

GET

List VC Info

Lists Virtual Centers configured in the environment.

POST

Register RCX Client

Registers the RCX client

DELETE

Unregister RCX Client

Unregisters the given RCX Client

PUT

Update Feature Settings Using PUT

Updates the feature settings.

PUT

Update General Settings Using PUT

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 RCX Client

Updates the given RCX client.

PUT

Update Security Settings Using PUT

Updates the security settings.

PUT

Update Settings Using PUT

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

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

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

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.

External

POST

Change User Password

Changes the password of AD User

GET

Get AD User Or Group Info

Get information related to AD User or Group

GET

List AD Domains

Lists information related to AD Domains of the environment.

GET

List AD User Or Group Summary

Lists AD users or groups information.

GET

List Base Snapshots

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/linked clone desktop 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 Paths

Lists all the folder paths within a Datastore from vCenter.

GET

Listdatastores

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

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 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 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

Validate AD User Encrypted Credentials

Validates the encrypted credentials of AD User

Inventory

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

Assign Users

Assigns the specified users to the machine.

POST

Create Application Pool

Creates an application pool.

DELETE

Delete Application Pool

Deletes application pool.

DELETE

Delete Machine

Deletes the machine.

DELETE

Delete Machines

Deletes the specified machines.

POST

Disconnect Sessions

Disconnects user sessions

POST

Enter Maintenance

Puts the machines into maintenance mode.

POST

Exit Maintenance

Puts the machines out of maintenance mode.

GET

Get Application Icon

Gets application icon.

GET

Get Application Pool

Gets application pool.

GET

Get Desktop Pool

Gets the Desktop Pool information.

GET

Get Desktop Pool V2

Gets the desktop pool information.

GET

Get Farm

Gets the Farm information.

GET

Get Machine Using GET

Gets the Machine information.

GET

Get Session Info

Gets the Session information.

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 Desktop Pools

Lists the Desktop Pools in the environment.

GET

List Desktop Pools V2

Lists the desktop pools in the environment.

GET

List Farms

Lists the Farms in the environment.

GET

List Installed Applications

Lists the installed applications on the given desktop pool.

GET

List Installed Applications 1

Lists the installed applications on the given farm.

GET

List Machines Using GET

Lists the Machines in the environment.

GET

List Session Info

Lists the Session information in the environment.

POST

Log Off Sessions

Logs off user sessions, if they are not locked.

POST

Rebuild Machines

Rebuilds the specified machines.

POST

Recover Machines

Recovers the specified machines.

POST

Remove Machines

Removes machines from the given manual desktop pool.

POST

Reset Machines

Resets the specified machines.

POST

Reset Sessions

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.

POST

Restart Machines

Restarts the specified machines.

POST

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.

POST

Send Message To Sessions

Sends the message to user sessions

POST

Unassign Users

Un-assigns the specified users from the machine.

PUT

Update Application Pool

Updates application 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

Gets monitoring information of view composer for a given virtual center

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 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 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

Lists monitoring information related to View Composers of the environment.

GET

List View Composer Monitors V2

Lists monitoring information related to View Composers of the environment.

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.