Inventory APIs
APIs for inventory resources
Operations
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
Application Icon Bulk Associate
Associates a custom icon to given list of application pools.
POST
Application Icon Bulk Remove Association
Removes custom icon association from given list of application pools.
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
Attach Persistent Disk
Attaches the specified persistent disk to a machine.
POST
Cancel Agent Upgrades
cancel agent upgrades.
POST
Cancel Desktop Pool Task
Cancels the instant clone desktop pool push image task.
POST
Cancel Rds Server Agent Upgrades
cancel agent upgrades.
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 Application Pool V3
Creates an application pool.
POST
Create Application Pool V5
Creates an application pool.
POST
Create Desktop Pool
Creates a desktop pool.
POST
Create Desktop Pool V2
Creates a desktop pool.
POST
Create Desktop Pool V7
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 Farm V6
Creates a farm.
POST
Create Global Application Entitlement
Creates a Global Application Entitlement.
POST
Create Global Application Entitlement V3
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.
POST
Create Global Desktop Entitlement V3
Creates a Global Desktop Entitlement.
POST
Create Persistent Disk
Creates a persistent disk.
POST
Create Policy Overrides For Users
Creates policies overrides for users on the given desktop pool.
DELETE
Delete Application Icon
Deletes customized application icon.
DELETE
Delete Application Pool
Deletes application pool.
DELETE
Delete Application Pools
Deletes the given application pools.
DELETE
Delete Application Pools V5
Deletes the given application pools.
DELETE
Delete Desktop Pool
Deletes a desktop pool.
DELETE
Delete Desktop Pool V7
Deletes a desktop pool.
DELETE
Delete Farm
Deletes a farm.
DELETE
Delete Farm V6
Deletes a farm.
DELETE
Delete Global Application Entitlement
Deletes a Global Application Entitlement.
DELETE
Delete Global Application Entitlement V3
Deletes a Global Application Entitlement.
DELETE
Delete Global Desktop Entitlement
Deletes a Global Desktop Entitlement.
DELETE
Delete Global Desktop Entitlement V3
Deletes a Global Desktop Entitlement.
DELETE
Delete Machine
Deletes the machine.
DELETE
Delete Machines
Deletes the specified machines.
DELETE
Delete Persistent Disk
Deletes persistent disk.
DELETE
Delete Physical Machine
Deletes the Physical Machine.
DELETE
Delete Policy Overrides For Users
Deletes policies overrides for users on the given desktop pool.
DELETE
Delete RDS Server
Deletes the RDS Server.
DELETE
Delete RDS Server V2
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
Detach Persistent Disk
Detaches the specified persistent disk from a machine.
POST
Disable Application Pools
Disables the given list of application pool ids.
POST
Disable Desktop Pools
Disables the given list of desktop pool ids.
POST
Disable Provisioning For Desktop Pools
Disables provisioning for the given list of desktop pool ids.
POST
Disconnect Global Sessions
Disconnects global sessions in the environment.
POST
Disconnect Sessions
Disconnects locally resourced user sessions.
POST
Enable Application Pools
Enables the given list of application pool ids.
POST
Enable Desktop Pools
Enables the given list of desktop pool ids.
POST
Enable Provisioning For Desktop Pools
Enables provisioning for the given list of desktop pool ids.
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 Agent Installer Package
Retrieves an agent installer package.
GET
Get Agent Upgrade Task
Get agent upgrade task information.
GET
Get Agent Upgrade Task V2
Get agent upgrade task information.
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 Application Pool V4
Gets application pool.
GET
Get Application Pool V5
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 Desktop Pool V7
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 Farm V5
Gets the Farm information.
GET
Get Farm V6
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 Application Entitlement V3
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 Global Desktop Entitlement V3
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 Machine V4
Gets the Machine information.
GET
Get Machine V5
Gets the Machine information.
GET
Get Persistent Disk
Retrieves information about a persistent disk.
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 Rds Server Agent Upgrade Task
Get agent upgrade task information.
GET
Get RDS Server V2
Gets the RDS Server information.
GET
Get Session Info
Gets the Session information for locally resourced session.
GET
List Agent Installer Packages
Lists agent installer packages.
GET
List Agent Upgrade Tasks
List agent upgrade tasks information.
GET
List Agent Upgrade Tasks V2
List agent upgrade tasks 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 Application Pools V2
Lists the application pools in the environment.
GET
List Application Pools V3
Lists the application pools in the environment.
GET
List Application Pools V4
Lists the application pools in the environment.
GET
List Application Pools V5
Lists the application pools in the environment.
GET
List App Volumes Applications On Farm
Lists the App Volumes applications on the given farm.
GET
List Attachable Machines
Lists machines which can be attached to persistent disk.
GET
List Category Folders
Lists the category folders.
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 Custom Application Icons
Lists the custom application icons.
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 Pools V7
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 Farms V5
Lists the Farms in the environment.
GET
List Farms V6
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 Application Entitlements V3
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 Global Desktop Entitlements V3
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 Machines V4
Lists the Machines in the environment.
GET
List Machines V5
Lists the Machines in the environment.
GET
List Persistent Disks
Lists persistent disks.
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 Policies On Desktop Pool
Returns the policies on the given desktop pool.
GET
List Rds Server Agent Upgrade Tasks
List agent upgrade tasks information.
GET
List RDS Servers
Lists the RDS Servers in the environment.
GET
List RDS Servers V2
Lists the RDS Servers in the environment.
GET
List Session Info
Lists the locally resourced Sessions in the environment
GET
List Unentitled Machines
Lists the unentitled machines in the environment.
GET
List User Policies Overrides
Returns policy overrides for entitled or unentitled users.
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
Recreate From Persistent Disk
Recreates machines from the specified persistent disks.
POST
Register Agent Installer Package
Registers an agent installer package.
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 Agent For Upgrade
Schedule agents for upgrade.
POST
Schedule Agent For Upgrade Rds Server
Schedule agents for upgrade.
POST
Schedule Agent For Upgrade V2
Schedule agents for upgrade.
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.
POST
Unregister Agent Installer Package
Unregisters an agent installer package.
PUT
Update Application Pool
Updates application pool.
PUT
Update Application Pool V2
Updates application pool.
PUT
Update Application Pool V3
Updates application pool.
PUT
Update Application Pool V5
Updates application pool.
PUT
Update Desktop Pool
Updates desktop pool.
PUT
Update Desktop Poolv7
Updates desktop pool.
PUT
Update Farm
Updates farm.
PUT
Update Farm V2
Updates farm.
PUT
Update Farm V3
Updates farm.
PUT
Update Farm V6
Updates farm.
PUT
Update Global Application Entitlement
Updates a Global Application Entitlement.
PUT
Update Global Application Entitlement V3
Updates a Global Application Entitlement.
PUT
Update Global Desktop Entitlement
Updates a Global Desktop Entitlement.
PUT
Update Global Desktop Entitlement V3
Updates a Global Desktop Entitlement.
PUT
Update Persistent Disk
Updates persistent disk.
PUT
Update Policy Overrides For Users
Updates policies overrides for users on the given desktop pool.
PUT
Update RDS Server
Updates the RDS Server.
PUT
Update RDS Server V2
Updates the RDS Server.
PUT
Updates Policies On Desktop Pool
Updates the policies on the given desktop pool.
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.