top of page

Omnissa Horizon 8 API Roundup

  • Writer: Christopher Reed
    Christopher Reed
  • May 7
  • 43 min read

This roundup is for anyone looking to move to Infrastructure as code. APIs and API changes are the key to success. Version numbers are critical, and ensuring your API endpoint calls are properly formed is the difference between success and failure.


Here, we focus on the public REST API documentation for Omnissa Horizon 8/Horizon Server from the Omnissa Developer Portal. The current API explorer surfaced by the portal is Horizon Server 2603, and the machine-readable Swagger contract contains 1,053 endpoint operations.


Changes in the Last 7 Days


  • Review window: April 30-May 7, 2026


  • No endpoint-level additions, removals, or updates were detected in the public Horizon Server API source history during this window.


  • No Horizon Server Developer Portal spec refreshes were detected during this window.



Source Material







Latest API Snapshot


  • Product: Horizon 8 / Horizon Server, also identified by the portal as Horizon Enterprise.


  • Current REST API version reviewed: 2603


  • Current endpoint operations documented: 1,053


  • Previous REST API version compared: 2512 (1,003 endpoint operations)


  • Current endpoint areas: Inventory: 459; Configuration: 336; Monitoring: 86; External Infrastructure: 82; Federation: 45; Entitlements: 20; Help Desk: 20; Login: 2; Key Agreement: 1; Logout: 1; Session Refresh: 1





What Is New in 2603 Compared With 2512


  • Added endpoint operations: 61 (Configuration: 32; Inventory: 23; Monitoring: 5; Help Desk: 1)


  • Removed endpoint operations: 11 (Configuration: 11)


  • Updated endpoint descriptions or metadata: 2 (Configuration: 2)


  • What it could mean: 2603 expands automation around external deployments, authenticator-to-Connection-Server association workflows, event database configuration, newer settings versions, capacity-provider inventory, RDS/session visibility, and selected monitoring views.


  • Planning note: if your scripts still call removed Connection Server installer package or install/upgrade/precheck endpoints, validate whether the newer Horizon Server LCM documentation is the right supported path before carrying those calls forward.


Added in 2603


  • DELETE /config/v1/external-deployments/{id} - Deletes the given external deployment

  • DELETE /config/v2/jwt-authenticators/{id} - Deletes the given JWT authenticator.

  • DELETE /config/v3/permissions - Deletes permissions in bulk.

  • DELETE /inventory/v2/cp-farms/{id} - Deletes a farm.

  • DELETE /inventory/v3/cp-desktop-pools/{id} - Deletes a capacity provider desktop pool.

  • DELETE /inventory/v7/rds-servers/{id} - Deletes the RDS Server.

  • GET /config/v1/external-deployments - Lists the configured external deployments.

  • GET /config/v1/external-deployments/{id} - Retrieves information about an external deployment.

  • GET /config/v10/settings - Retrieves the configuration settings.

  • GET /config/v11/settings - Retrieves the configuration settings.

  • GET /config/v2/event-database - Returns information about event database configuration.

  • GET /config/v2/jwt-authenticators - Lists the configured JWT authenticators.

  • GET /config/v2/jwt-authenticators/{id} - Retrieves information about the given JWT authenticator.

  • GET /config/v2/settings/client-settings - Retrieves the client settings.

  • GET /config/v3/permissions - Lists all permissions.

  • GET /config/v3/permissions/{id} - Retrieves a permission.

  • GET /config/v5/settings/feature - Retrieves the feature settings.

  • GET /helpdesk/v1/performance/remote-application/s4b-pairing-mode - Retrieves the remote applications s4b pairing mode information.

  • GET /inventory/v2/cp-farms - Lists the Farms in the environment.

  • GET /inventory/v2/cp-farms/{id} - Gets the Farm information.

  • GET /inventory/v2/desktop-pools/policies/overrides - Returns policy overrides for entitled or unentitled users.

  • GET /inventory/v3/cp-desktop-pools - Lists the capacity provider Desktop Pools in the environment.

  • GET /inventory/v3/cp-desktop-pools/{id} - Gets the capacity provider Desktop Pool information.

  • GET /inventory/v4/global-sessions - Lists global sessions in the environment for the given user, pod or brokering pod.

  • GET /inventory/v6/physical-machines - Lists the Physical Machines in the environment.

  • GET /inventory/v6/physical-machines/{id} - Gets the Physical Machine information.

  • GET /inventory/v7/rds-servers - Lists the RDS Servers in the environment.

  • GET /inventory/v7/rds-servers/{id} - Gets the RDS Server information.

  • GET /inventory/v8/sessions - Lists the locally resourced Sessions in the environment

  • GET /inventory/v8/sessions/{id} - Gets the Session information for locally resourced session.

  • GET /monitor/v3/event-database - Returns monitoring information related to Event database of the environment.

  • GET /monitor/v4/rds-servers - Lists monitoring information related to RDS Servers of the environment.

  • GET /monitor/v4/rds-servers/{id} - Gets monitoring information related to RDS Server.

  • GET /monitor/v5/virtual-centers - Lists monitoring information related to Virtual Centers of the environment.

  • GET /monitor/v5/virtual-centers/{id} - Gets monitoring information related to Virtual Center.

  • POST /config/v1/external-deployments - Add the external deployment

  • POST /config/v1/external-deployments/action/refresh-keys - Refreshes public keys for external deployment feature.

  • POST /config/v1/external-deployments/action/validate-certificate - Validates External Deployment connection server certificate.

  • POST /config/v1/jwt-authenticators/{id}/action/associate-connection-servers - Associates JWT authenticator with multiple connection servers.

  • POST /config/v1/jwt-authenticators/{id}/action/dissociate-connection-servers - Dissociate JWT authenticator with multiple connection servers.

  • POST /config/v1/saml-authenticators/{id}/action/associate-connection-servers - Associates SAML authenticator with multiple connection servers with specified state.

  • POST /config/v1/saml-authenticators/{id}/action/dissociate-connection-servers - Dissociate SAML authenticator with multiple connection servers.

  • POST /config/v2/event-database/action/clear - Deletes event database configuration.

  • POST /config/v2/event-database/action/validate-service-account - Validates service account credentials.

  • POST /config/v2/jwt-authenticators - Creates a JWT authenticator.

  • POST /config/v3/permissions - Creates permissions in bulk.

  • POST /inventory/v1/application-pools/action/update-allowed-access-path - Updates allowed access path for the given list of application pool ids.

  • POST /inventory/v1/desktop-pools/action/update-allowed-access-path - Update allowed access path for the given list of desktop pool ids.

  • POST /inventory/v2/cp-farms - Creates a farm.

  • POST /inventory/v3/cp-desktop-pools - Creates a capacity provider desktop pool.

  • POST /inventory/v4/desktop-pools/{id}/action/schedule-push-image - Schedule/reschedule a request to update the image in an instant clone desktop pool.

  • PUT /config/v1/external-deployments/{id} - Updates the given external deployment.

  • PUT /config/v10/settings - Updates the configuration settings.

  • PUT /config/v11/settings - Updates the configuration settings.

  • PUT /config/v2/event-database - Updates event database configuration.

  • PUT /config/v2/jwt-authenticators/{id} - Updates the given JWT authenticator.

  • PUT /config/v2/settings/client-settings - Updates the client settings.

  • PUT /config/v5/settings/feature - Updates the feature settings.

  • PUT /inventory/v2/cp-farms/{id} - Updates farm.

  • PUT /inventory/v3/cp-desktop-pools/{id} - Updates capacity provider desktop pool.

  • PUT /inventory/v7/rds-servers/{id} - Updates the RDS Server.


Removed From 2603 Compared With 2512


  • GET /config/v1/server-installer-packages - Lists server installer packages.

  • GET /config/v1/server-installer-packages/{id} - Retrieves a server installer package.

  • POST /config/v1/connection-servers/action/install-connection-server - Install connection server in remote machine.

  • POST /config/v1/connection-servers/action/retrieve-installer-status - Retrieve connection server installer status.

  • POST /config/v1/connection-servers/action/upgrade-connection-server - Upgrade connection server in remote machine.

  • POST /config/v1/connection-servers/action/validate-ad-requirements - Perform Active Directory Requirements Validation

  • POST /config/v1/connection-servers/action/validate-ldap-requirements - Perform Horizon POD ldap requirements validation

  • POST /config/v1/connection-servers/action/validate-system-requirements - Perform Horizon Server System requirements validation

  • POST /config/v1/connection-servers/action/validate-virtual-center-requirements - Perform Virtual Center Server PreCheck

  • POST /config/v1/server-installer-packages/{id}/action/unregister - Unregisters a server installer package.

  • POST /config/v1/server-installer-packages/action/register - Registers a server installer package.


Updated Descriptions or Metadata


  • GET /config/v1/event-database - Returns information about event database configuration.

  • PUT /config/v1/event-database - Updates event database configuration.


Endpoint Areas at a Glance


  • Inventory (459 operations) - Operational inventory for desktop pools, farms, RDS servers, applications, machines, sessions, persistent disks, images, global entitlements, and pool or farm actions.


  • Configuration (336 operations) - Connection Server configuration, authentication integrations, global policies, certificates, logging, roles, permissions, True SSO, UEM servers, virtual centers, and environment-wide settings.


  • Monitoring (86 operations) - Read-only health, usage, capacity, metrics, and component-state visibility for pods, gateways, virtual centers, sessions, desktops, farms, and supporting services.


  • External Infrastructure (82 operations) - Discovery and validation of external resources such as Active Directory, vCenter, base VMs, snapshots, datastores, networks, capacity providers, and templates.


  • Federation (45 operations) - Cloud Pod Architecture and multi-site objects such as pods, sites, home sites, federations, global summary, and topology-related operations.


  • Entitlements (20 operations) - User and group access assignments for desktop pools, application pools, global desktop entitlements, and global application entitlements.


  • Help Desk (20 operations) - User-support and troubleshooting surfaces for sessions, processes, applications, performance details, and remote assistance workflows.


  • Login (2 operations) - Authentication entry points used to create or validate an API session.


  • Key Agreement (1 operations) - Negotiates key material used by client/API authentication flows.


  • Logout (1 operations) - Session termination for an authenticated API session.


  • Session Refresh (1 operations) - Refreshes an authenticated API session or token context.


Complete Horizon Server 2603 Endpoint Reference


The list below translates every endpoint operation in the current public Horizon Server 2603 Swagger contract into a short human-readable description. Use the linked Swagger JSON for request bodies, response schemas, parameters, and exact machine-readable details.


Inventory Endpoints


  • DELETE /inventory/v1/application-icons/{id} - Deletes customized application icon.

  • DELETE /inventory/v1/application-pools/{id} - Deletes application pool.

  • DELETE /inventory/v1/cp-desktop-pools/{id} - Deletes a capacity provider desktop pool.

  • DELETE /inventory/v1/cp-farms/{id} - Deletes a farm.

  • DELETE /inventory/v1/desktop-pools/{id} - Deletes a desktop pool.

  • DELETE /inventory/v1/desktop-pools/{id}/policies/overrides - Deletes policies overrides for users on the given desktop pool.

  • DELETE /inventory/v1/farms/{id} - Deletes a farm.

  • DELETE /inventory/v1/global-application-entitlements/{id} - Deletes a Global Application Entitlement.

  • DELETE /inventory/v1/global-application-entitlements/{id}/local-application-pools - Removes Local Application Pools from Global Application Entitlement.

  • DELETE /inventory/v1/global-desktop-entitlements/{id} - Deletes a Global Desktop Entitlement.

  • DELETE /inventory/v1/global-desktop-entitlements/{id}/local-desktop-pools - Removes Local Desktop Pools from Global Desktop Entitlement.

  • DELETE /inventory/v1/machines - Deletes the specified machines.

  • DELETE /inventory/v1/machines/{id} - Deletes the machine.

  • DELETE /inventory/v1/persistent-disks/{id} - Deletes persistent disk.

  • DELETE /inventory/v1/physical-machines/{id} - Deletes the Physical Machine.

  • DELETE /inventory/v1/rds-servers/{id} - Deletes the RDS Server.

  • DELETE /inventory/v10/application-pools - Deletes the given application pools.

  • DELETE /inventory/v10/application-pools/{id} - Deletes application pool.

  • DELETE /inventory/v10/desktop-pools/{id} - Deletes a desktop pool.

  • DELETE /inventory/v10/machines - Deletes the specified machines.

  • DELETE /inventory/v10/machines/{id} - Deletes the machine.

  • DELETE /inventory/v11/desktop-pools/{id} - Deletes a desktop pool.

  • DELETE /inventory/v12/desktop-pools/{id} - Deletes a desktop pool.

  • DELETE /inventory/v2/cp-desktop-pools/{id} - Deletes a capacity provider desktop pool.

  • DELETE /inventory/v2/cp-farms/{id} - Deletes a farm.

  • DELETE /inventory/v2/rds-servers/{id} - Deletes the RDS Server.

  • DELETE /inventory/v3/cp-desktop-pools/{id} - Deletes a capacity provider desktop pool.

  • DELETE /inventory/v3/global-application-entitlements/{id} - Deletes a Global Application Entitlement.

  • DELETE /inventory/v3/global-desktop-entitlements/{id} - Deletes a Global Desktop Entitlement.

  • DELETE /inventory/v3/rds-servers/{id} - Deletes the RDS Server.

  • DELETE /inventory/v4/application-pools - Deletes the given application pools.

  • DELETE /inventory/v4/global-application-entitlements/{id} - Deletes a Global Application Entitlement.

  • DELETE /inventory/v4/global-desktop-entitlements/{id} - Deletes a Global Desktop Entitlement.

  • DELETE /inventory/v4/physical-machines - Deletes the Physical Machines.

  • DELETE /inventory/v4/rds-servers/{id} - Deletes the RDS Server.

  • DELETE /inventory/v5/application-pools - Deletes the given application pools.

  • DELETE /inventory/v5/global-desktop-entitlements/{id} - Deletes a Global Desktop Entitlement.

  • DELETE /inventory/v5/rds-servers/{id} - Deletes the RDS Server.

  • DELETE /inventory/v6/application-pools - Deletes the given application pools.

  • DELETE /inventory/v6/farms/{id} - Deletes a farm.

  • DELETE /inventory/v6/global-application-entitlements/{id} - Deletes a Global Application Entitlement.

  • DELETE /inventory/v6/global-desktop-entitlements/{id} - Deletes a Global Desktop Entitlement.

  • DELETE /inventory/v6/rds-servers/{id} - Deletes the RDS Server.

  • DELETE /inventory/v7/application-pools - Deletes the given application pools.

  • DELETE /inventory/v7/application-pools/{id} - Deletes application pool.

  • DELETE /inventory/v7/desktop-pools/{id} - Deletes a desktop pool.

  • DELETE /inventory/v7/farms/{id} - Deletes a farm.

  • DELETE /inventory/v7/global-application-entitlements/{id} - Deletes a Global Application Entitlement.

  • DELETE /inventory/v7/global-desktop-entitlements/{id} - Deletes a Global Desktop Entitlement.

  • DELETE /inventory/v7/rds-servers/{id} - Deletes the RDS Server.

  • DELETE /inventory/v8/application-pools - Deletes the given application pools.

  • DELETE /inventory/v8/application-pools/{id} - Deletes application pool.

  • DELETE /inventory/v8/desktop-pools/{id} - Deletes a desktop pool.

  • DELETE /inventory/v8/farms/{id} - Deletes a farm.

  • DELETE /inventory/v8/machines - Deletes the specified machines.

  • DELETE /inventory/v8/machines/{id} - Deletes the machine.

  • DELETE /inventory/v9/application-pools - Deletes the given application pools.

  • DELETE /inventory/v9/application-pools/{id} - Deletes application pool.

  • DELETE /inventory/v9/desktop-pools/{id} - Deletes a desktop pool.

  • DELETE /inventory/v9/farms/{id} - Deletes a farm.

  • DELETE /inventory/v9/machines - Deletes the specified machines.

  • DELETE /inventory/v9/machines/{id} - Deletes the machine.

  • GET /inventory/v1/agent-installer-packages - Lists agent installer packages.

  • GET /inventory/v1/agent-installer-packages/{id} - Retrieves an agent installer package.

  • GET /inventory/v1/application-icons - Lists the application icons for the given application pool.

  • GET /inventory/v1/application-icons/{id} - Gets application icon.

  • GET /inventory/v1/application-icons/custom-icons - Lists the custom application icons.

  • GET /inventory/v1/application-pools - Lists the application pools in the environment.

  • GET /inventory/v1/application-pools/{id} - Gets application pool.

  • GET /inventory/v1/category-folders - Lists the category folders.

  • GET /inventory/v1/cp-desktop-pools - Lists the capacity provider Desktop Pools in the environment.

  • GET /inventory/v1/cp-desktop-pools/{id} - Gets the capacity provider Desktop Pool information.

  • GET /inventory/v1/cp-farms - Lists the Farms in the environment.

  • GET /inventory/v1/cp-farms/{id} - Gets the Farm information.

  • GET /inventory/v1/desktop-pools - Lists the Desktop Pools in the environment.

  • GET /inventory/v1/desktop-pools/{id} - Gets the Desktop Pool information.

  • GET /inventory/v1/desktop-pools/{id}/installed-applications - Lists the installed applications on the given desktop pool.

  • GET /inventory/v1/desktop-pools/{id}/policies - Returns the policies on the given desktop pool.

  • GET /inventory/v1/desktop-pools/{id}/tasks - Lists the tasks on the desktop pool.

  • GET /inventory/v1/desktop-pools/{id}/tasks/{taskId} - Gets the task information on the desktop pool.

  • GET /inventory/v1/desktop-pools/policies/overrides - Returns policy overrides for entitled or unentitled users.

  • GET /inventory/v1/farms - Lists the Farms in the environment.

  • GET /inventory/v1/farms/{id} - Gets the Farm information.

  • GET /inventory/v1/farms/{id}/app-volumes-applications - Lists the App Volumes applications on the given farm.

  • GET /inventory/v1/farms/{id}/installed-applications - Lists the installed applications on the given farm.

  • GET /inventory/v1/global-application-entitlements - Lists the Global Application Entitlements in the environment.

  • GET /inventory/v1/global-application-entitlements/{id} - Gets the Global Application Entitlement in the environment.

  • GET /inventory/v1/global-application-entitlements/{id}/compatible-backup-global-application-entitlements - Lists the Global Application Entitlements that can be associated as backup Global Application Entitlement.

  • GET /inventory/v1/global-application-entitlements/{id}/compatible-local-application-pools - Lists Local Application Pools which are compatible with Global Application Entitlement.

  • GET /inventory/v1/global-application-entitlements/{id}/local-application-pools - Lists Local Application Pools which are assigned to Global Application Entitlement.

  • GET /inventory/v1/global-desktop-entitlements - Lists the Global Desktop Entitlements in the environment.

  • GET /inventory/v1/global-desktop-entitlements/{id} - Gets the Global Desktop Entitlement in the environment.

  • GET /inventory/v1/global-desktop-entitlements/{id}/compatible-backup-global-desktop-entitlements - Lists the Global Desktop Entitlements that can be associated as backup Global Desktop Entitlement.

  • GET /inventory/v1/global-desktop-entitlements/{id}/compatible-local-desktop-pools - Lists Local Desktop Pools which are compatible with Global Desktop Entitlement.

  • GET /inventory/v1/global-desktop-entitlements/{id}/local-desktop-pools - Lists Local Desktop Pools which are assigned to Global Desktop Entitlement.

  • GET /inventory/v1/global-sessions - Lists global sessions in the environment for the given user, pod or brokering pod.

  • GET /inventory/v1/machines - Lists the Machines in the environment.

  • GET /inventory/v1/machines/{id} - Gets the Machine information.

  • GET /inventory/v1/machines/agent-upgrade-tasks - List agent upgrade tasks information.

  • GET /inventory/v1/machines/agent-upgrade-tasks/{id} - Get agent upgrade task information.

  • GET /inventory/v1/machines/unentitled - Lists the unentitled machines in the environment.

  • GET /inventory/v1/persistent-disks - Lists persistent disks.

  • GET /inventory/v1/persistent-disks/{id} - Retrieves information about a persistent disk.

  • GET /inventory/v1/persistent-disks/{id}/attachable-machines - Lists machines which can be attached to persistent disk.

  • GET /inventory/v1/physical-machines - Lists the Physical Machines in the environment.

  • GET /inventory/v1/physical-machines/{id} - Gets the Physical Machine information.

  • GET /inventory/v1/rds-servers - Lists the RDS Servers in the environment.

  • GET /inventory/v1/rds-servers/{id} - Gets the RDS Server information.

  • GET /inventory/v1/rds-servers/agent-upgrade-tasks - List agent upgrade tasks information.

  • GET /inventory/v1/rds-servers/agent-upgrade-tasks/{id} - Get agent upgrade task information.

  • GET /inventory/v1/sessions - Lists the locally resourced Sessions in the environment

  • GET /inventory/v1/sessions/{id} - Gets the Session information for locally resourced session.

  • GET /inventory/v10/application-pools - Lists the application pools in the environment.

  • GET /inventory/v10/application-pools/{id} - Gets application pool.

  • GET /inventory/v10/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v10/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v10/machines - Lists the Machines in the environment.

  • GET /inventory/v10/machines/{id} - Gets the machine information.

  • GET /inventory/v11/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v11/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v12/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v12/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v2/agent-installer-packages - Lists agent installer packages.

  • GET /inventory/v2/agent-installer-packages/{id} - Retrieves an agent installer package.

  • GET /inventory/v2/application-pools - Lists the application pools in the environment.

  • GET /inventory/v2/application-pools/{id} - Gets application pool.

  • GET /inventory/v2/cp-desktop-pools - Lists the capacity provider Desktop Pools in the environment.

  • GET /inventory/v2/cp-desktop-pools/{id} - Gets the capacity provider Desktop Pool information.

  • GET /inventory/v2/cp-farms - Lists the Farms in the environment.

  • GET /inventory/v2/cp-farms/{id} - Gets the Farm information.

  • GET /inventory/v2/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v2/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v2/desktop-pools/policies/overrides - Returns policy overrides for entitled or unentitled users.

  • GET /inventory/v2/farms - Lists the Farms in the environment.

  • GET /inventory/v2/farms/{id} - Gets the Farm information.

  • GET /inventory/v2/global-application-entitlements - Lists the Global Application Entitlements in the environment.

  • GET /inventory/v2/global-application-entitlements/{id} - Gets the Global Application Entitlement in the environment.

  • GET /inventory/v2/global-desktop-entitlements - Lists the Global Desktop Entitlements in the environment.

  • GET /inventory/v2/global-desktop-entitlements/{id} - Gets the Global Desktop Entitlement in the environment.

  • GET /inventory/v2/global-sessions - Lists global sessions in the environment for the given user, pod or brokering pod.

  • GET /inventory/v2/machines - Lists the Machines in the environment.

  • GET /inventory/v2/machines/{id} - Gets the Machine information.

  • GET /inventory/v2/machines/agent-upgrade-tasks - List agent upgrade tasks information.

  • GET /inventory/v2/machines/agent-upgrade-tasks/{id} - Get agent upgrade task information.

  • GET /inventory/v2/physical-machines - Lists the Physical Machines in the environment.

  • GET /inventory/v2/physical-machines/{id} - Gets the Physical Machine information.

  • GET /inventory/v2/rds-servers - Lists the RDS Servers in the environment.

  • GET /inventory/v2/rds-servers/{id} - Gets the RDS Server information.

  • GET /inventory/v2/rds-servers/agent-upgrade-tasks - List agent upgrade tasks information.

  • GET /inventory/v2/rds-servers/agent-upgrade-tasks/{id} - Get agent upgrade task information.

  • GET /inventory/v2/sessions - Lists the locally resourced Sessions in the environment

  • GET /inventory/v3/agent-installer-packages - Lists agent installer packages.

  • GET /inventory/v3/agent-installer-packages/{id} - Retrieves an agent installer package.

  • GET /inventory/v3/application-pools - Lists the application pools in the environment.

  • GET /inventory/v3/application-pools/{id} - Gets application pool.

  • GET /inventory/v3/cp-desktop-pools - Lists the capacity provider Desktop Pools in the environment.

  • GET /inventory/v3/cp-desktop-pools/{id} - Gets the capacity provider Desktop Pool information.

  • GET /inventory/v3/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v3/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v3/farms - Lists the Farms in the environment.

  • GET /inventory/v3/farms/{id} - Gets the Farm information.

  • GET /inventory/v3/global-application-entitlements - Lists the Global Application Entitlements in the environment.

  • GET /inventory/v3/global-application-entitlements/{id} - Gets the Global Application Entitlement in the environment.

  • GET /inventory/v3/global-desktop-entitlements - Lists the Global Desktop Entitlements in the environment.

  • GET /inventory/v3/global-desktop-entitlements/{id} - Gets the Global Desktop Entitlement in the environment.

  • GET /inventory/v3/global-sessions - Lists global sessions in the environment for the given user, pod or brokering pod.

  • GET /inventory/v3/machines - Lists the Machines in the environment.

  • GET /inventory/v3/machines/{id} - Gets the Machine information.

  • GET /inventory/v3/machines/agent-upgrade-tasks - List agent upgrade tasks information.

  • GET /inventory/v3/machines/agent-upgrade-tasks/{id} - Get agent upgrade task information.

  • GET /inventory/v3/physical-machines - Lists the Physical Machines in the environment.

  • GET /inventory/v3/physical-machines/{id} - Gets the Physical Machine information.

  • GET /inventory/v3/rds-servers - Lists the RDS Servers in the environment.

  • GET /inventory/v3/rds-servers/{id} - Gets the RDS Server information.

  • GET /inventory/v3/rds-servers/agent-upgrade-tasks - List agent upgrade tasks information.

  • GET /inventory/v3/rds-servers/agent-upgrade-tasks/{id} - Get agent upgrade task information.

  • GET /inventory/v3/sessions - Lists the locally resourced Sessions in the environment

  • GET /inventory/v3/sessions/{id} - Gets the Session information for locally resourced session.

  • GET /inventory/v4/application-pools - Lists the application pools in the environment.

  • GET /inventory/v4/application-pools/{id} - Gets application pool.

  • GET /inventory/v4/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v4/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v4/farms - Lists the Farms in the environment.

  • GET /inventory/v4/farms/{id} - Gets the Farm information.

  • GET /inventory/v4/global-application-entitlements - Lists the Global Application Entitlements in the environment.

  • GET /inventory/v4/global-application-entitlements/{id} - Gets the Global Application Entitlement in the environment.

  • GET /inventory/v4/global-desktop-entitlements - Lists the Global Desktop Entitlements in the environment.

  • GET /inventory/v4/global-desktop-entitlements/{id} - Gets the Global Desktop Entitlement in the environment.

  • GET /inventory/v4/global-sessions - Lists global sessions in the environment for the given user, pod or brokering pod.

  • GET /inventory/v4/machines - Lists the Machines in the environment.

  • GET /inventory/v4/machines/{id} - Gets the machine information.

  • GET /inventory/v4/machines/agent-upgrade-tasks - List agent upgrade tasks information.

  • GET /inventory/v4/machines/agent-upgrade-tasks/{id} - Get agent upgrade task information.

  • GET /inventory/v4/physical-machines - Lists the Physical Machines in the environment.

  • GET /inventory/v4/physical-machines/{id} - Gets the Physical Machine information.

  • GET /inventory/v4/rds-servers - Lists the RDS Servers in the environment.

  • GET /inventory/v4/rds-servers/{id} - Gets the RDS Server information.

  • GET /inventory/v4/sessions - Lists the locally resourced Sessions in the environment

  • GET /inventory/v4/sessions/{id} - Gets the Session information for locally resourced session.

  • GET /inventory/v5/application-pools - Lists the application pools in the environment.

  • GET /inventory/v5/application-pools/{id} - Gets application pool.

  • GET /inventory/v5/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v5/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v5/farms - Lists the Farms in the environment.

  • GET /inventory/v5/farms/{id} - Gets the Farm information.

  • GET /inventory/v5/global-application-entitlements - Lists the Global Application Entitlements in the environment.

  • GET /inventory/v5/global-desktop-entitlements - Lists the Global Desktop Entitlements in the environment.

  • GET /inventory/v5/global-desktop-entitlements/{id} - Gets the Global Desktop Entitlement in the environment.

  • GET /inventory/v5/machines - Lists the Machines in the environment.

  • GET /inventory/v5/machines/{id} - Gets the machine information.

  • GET /inventory/v5/physical-machines - Lists the Physical Machines in the environment.

  • GET /inventory/v5/physical-machines/{id} - Gets the Physical Machine information.

  • GET /inventory/v5/rds-servers - Lists the RDS Servers in the environment.

  • GET /inventory/v5/rds-servers/{id} - Gets the RDS Server information.

  • GET /inventory/v5/sessions - Lists the locally resourced Sessions in the environment

  • GET /inventory/v5/sessions/{id} - Gets the Session information for locally resourced session.

  • GET /inventory/v6/application-pools - Lists the application pools in the environment.

  • GET /inventory/v6/application-pools/{id} - Gets application pool.

  • GET /inventory/v6/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v6/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v6/farms - Lists the Farms in the environment.

  • GET /inventory/v6/farms/{id} - Gets the Farm information.

  • GET /inventory/v6/global-application-entitlements - Lists the Global Application Entitlements in the environment.

  • GET /inventory/v6/global-application-entitlements/{id} - Gets the Global Application Entitlement in the environment.

  • GET /inventory/v6/global-desktop-entitlements - Lists the Global Desktop Entitlements in the environment.

  • GET /inventory/v6/global-desktop-entitlements/{id} - Gets the Global Desktop Entitlement in the environment.

  • GET /inventory/v6/machines - Lists the Machines in the environment.

  • GET /inventory/v6/machines/{id} - Gets the machine information.

  • GET /inventory/v6/physical-machines - Lists the Physical Machines in the environment.

  • GET /inventory/v6/physical-machines/{id} - Gets the Physical Machine information.

  • GET /inventory/v6/rds-servers - Lists the RDS Servers in the environment.

  • GET /inventory/v6/rds-servers/{id} - Gets the RDS Server information.

  • GET /inventory/v6/sessions - Lists the locally resourced Sessions in the environment

  • GET /inventory/v6/sessions/{id} - Gets the Session information for locally resourced session.

  • GET /inventory/v7/application-pools - Lists the application pools in the environment.

  • GET /inventory/v7/application-pools/{id} - Gets application pool.

  • GET /inventory/v7/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v7/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v7/farms - Lists the Farms in the environment.

  • GET /inventory/v7/farms/{id} - Gets the Farm information.

  • GET /inventory/v7/global-application-entitlements - Lists the Global Application Entitlements in the environment.

  • GET /inventory/v7/global-application-entitlements/{id} - Gets the Global Application Entitlement in the environment.

  • GET /inventory/v7/global-desktop-entitlements - Lists the Global Desktop Entitlements in the environment.

  • GET /inventory/v7/global-desktop-entitlements/{id} - Gets the Global Desktop Entitlement in the environment.

  • GET /inventory/v7/machines - Lists the Machines in the environment.

  • GET /inventory/v7/machines/{id} - Gets the machine information.

  • GET /inventory/v7/rds-servers - Lists the RDS Servers in the environment.

  • GET /inventory/v7/rds-servers/{id} - Gets the RDS Server information.

  • GET /inventory/v7/sessions - Lists the locally resourced Sessions in the environment

  • GET /inventory/v7/sessions/{id} - Gets the Session information for locally resourced session.

  • GET /inventory/v8/application-pools - Lists the application pools in the environment.

  • GET /inventory/v8/application-pools/{id} - Gets application pool.

  • GET /inventory/v8/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v8/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v8/farms - Lists the Farms in the environment.

  • GET /inventory/v8/farms/{id} - Gets the Farm information.

  • GET /inventory/v8/machines - Lists the Machines in the environment.

  • GET /inventory/v8/machines/{id} - Gets the machine information.

  • GET /inventory/v8/sessions - Lists the locally resourced Sessions in the environment

  • GET /inventory/v8/sessions/{id} - Gets the Session information for locally resourced session.

  • GET /inventory/v9/application-pools - Lists the application pools in the environment.

  • GET /inventory/v9/application-pools/{id} - Gets application pool.

  • GET /inventory/v9/desktop-pools - Lists the desktop pools in the environment.

  • GET /inventory/v9/desktop-pools/{id} - Gets the desktop pool information.

  • GET /inventory/v9/farms - Lists the Farms in the environment.

  • GET /inventory/v9/farms/{id} - Gets the Farm information.

  • GET /inventory/v9/machines - Lists the Machines in the environment.

  • GET /inventory/v9/machines/{id} - Gets the machine information.

  • POST /inventory/v1/agent-installer-packages/{id}/action/unregister - Unregisters an agent installer package.

  • POST /inventory/v1/agent-installer-packages/action/register - Registers an agent installer package.

  • POST /inventory/v1/application-icons - Creates an application icon.

  • POST /inventory/v1/application-pools - Creates an application pool.

  • POST /inventory/v1/application-pools/{id}/action/add-custom-icon - Associates a custom icon to the application pool.

  • POST /inventory/v1/application-pools/{id}/action/remove-custom-icon - Removes the associated custom icon from the application pool.

  • POST /inventory/v1/application-pools/action/associate - Associates a custom icon to given list of application pools.

  • POST /inventory/v1/application-pools/action/check-name-availability - Checks if the given name is available for application pool creation.

  • POST /inventory/v1/application-pools/action/disable - Disables the given list of application pool ids.

  • POST /inventory/v1/application-pools/action/enable - Enables the given list of application pool ids.

  • POST /inventory/v1/application-pools/action/migrate - Migrates the list of application pools to another farm

  • POST /inventory/v1/application-pools/action/remove-association - Removes custom icon association from given list of application pools.

  • POST /inventory/v1/application-pools/action/update-allowed-access-path - Updates allowed access path for the given list of application pool ids.

  • POST /inventory/v1/cp-desktop-pools - Creates a capacity provider desktop pool.

  • POST /inventory/v1/cp-desktop-pools/{id}/action/cancel-scheduled-push-image - Request the cancellation of the current scheduled push image operation or cancellation of promoted secondary image on the specified instant/linked clone desktop pool.

  • POST /inventory/v1/cp-desktop-pools/{id}/action/promote-pending-image - Promotes pending image to current image in the desktop pool.

  • POST /inventory/v1/cp-desktop-pools/{id}/action/schedule-push-image - Schedule/reschedule a request to update the image in an automated desktop pool.

  • POST /inventory/v1/cp-farms - Creates a farm.

  • POST /inventory/v1/cp-farms/{id}/action/apply-image - Applies the pending image or the current image to selected RDS servers in the farm.

  • POST /inventory/v1/cp-farms/{id}/action/cancel-scheduled-maintenance - Requests cancellation of the current scheduled maintenance on the specified farm.

  • POST /inventory/v1/cp-farms/{id}/action/promote-pending-image - Promotes pending image to current image in the farm.

  • POST /inventory/v1/cp-farms/{id}/action/schedule-maintenance - Creates maintenance schedule for the specified farm.

  • POST /inventory/v1/cp-farms/action/disable - Disables the given list of farm ids.

  • POST /inventory/v1/cp-farms/action/disable-provisioning - Disables provisioning for the given list of farm ids.

  • POST /inventory/v1/cp-farms/action/enable - Enables the given list of farm ids.

  • POST /inventory/v1/cp-farms/action/enable-provisioning - Enables provisioning for the given list of farm ids.

  • POST /inventory/v1/desktop-pools - Creates a desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/action/add-machines - Adds machines to the given manual desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/action/add-machines-by-name - Adds the named machines to the given desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/action/apply-image - Applies the pending image or the current image to selected machines in the desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/action/cancel-scheduled-push-image - Request the cancellation of the current scheduled push image operation on the specified instant clone desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/action/promote-pending-image - Promotes pending image to current image in the desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/action/remove-machines - Removes machines from the given manual desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/action/schedule-push-image - Schedule/reschedule a request to update the image in an instant clone desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/action/validate-installed-applications - Validates that each application in the given list is installed on the machines belonging to the specified desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/policies/overrides - Creates policies overrides for users on the given desktop pool.

  • POST /inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/cancel - Cancels the instant clone desktop pool push image task.

  • POST /inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/pause - Pause the instant clone desktop pool push image task.

  • POST /inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/resume - Resume the instant clone desktop pool push image task.

  • POST /inventory/v1/desktop-pools/action/check-name-availability - Checks if the given name is available for desktop pool creation.

  • POST /inventory/v1/desktop-pools/action/disable - Disables the given list of desktop pool ids.

  • POST /inventory/v1/desktop-pools/action/disable-provisioning - Disables provisioning for the given list of desktop pool ids.

  • POST /inventory/v1/desktop-pools/action/enable - Enables the given list of desktop pool ids.

  • POST /inventory/v1/desktop-pools/action/enable-provisioning - Enables provisioning for the given list of desktop pool ids.

  • POST /inventory/v1/desktop-pools/action/update-allowed-access-path - Update allowed access path for the given list of desktop pool ids.

  • POST /inventory/v1/desktop-pools/action/validate-specified-names - Validates manually specified virtual machines. Ensures machine and user names are valid and aren't duplicated in the given desktop pool.

  • POST /inventory/v1/farms - Creates a farm.

  • POST /inventory/v1/farms/{id}/action/add-rds-servers - Add RDS servers to the specified manual farm.

  • POST /inventory/v1/farms/{id}/action/apply-image - Applies the pending image or the current image to selected RDS servers in the farm.

  • POST /inventory/v1/farms/{id}/action/cancel-scheduled-maintenance - Requests cancellation of the current scheduled maintenance on the specified Instant Clone farm.

  • POST /inventory/v1/farms/{id}/action/promote-pending-image - Promotes pending image to current image in the farm.

  • POST /inventory/v1/farms/{id}/action/remove-rds-servers - Remove RDS servers from the specified farm.

  • POST /inventory/v1/farms/{id}/action/schedule-maintenance - Creates maintenance schedule for the specified farm.

  • POST /inventory/v1/farms/{id}/action/validate-installed-applications - Validates that each application in the given list is installed on the RDS Servers belonging to the specified Farm.

  • POST /inventory/v1/farms/action/check-name-availability - Checks if the given name is available for farm creation.

  • POST /inventory/v1/global-application-entitlements - Creates a Global Application Entitlement.

  • POST /inventory/v1/global-application-entitlements/{id}/local-application-pools - Adds Local Application Pools to Global Application Entitlement.

  • POST /inventory/v1/global-desktop-entitlements - Creates a Global Desktop Entitlement.

  • POST /inventory/v1/global-desktop-entitlements/{id}/local-desktop-pools - Adds Local Desktop Pools to Global Desktop Entitlement.

  • POST /inventory/v1/global-sessions/action/disconnect - Disconnects global sessions in the environment.

  • POST /inventory/v1/global-sessions/action/logoff - Logs off global sessions in the environment.

  • POST /inventory/v1/global-sessions/action/reset - Resets machines of global sessions in the environment.

  • POST /inventory/v1/global-sessions/action/restart - Restarts machines of global sessions in the environment.

  • POST /inventory/v1/global-sessions/action/send-message - Sends message to global sessions in the environment.

  • POST /inventory/v1/machines/{id}/action/assign-aliases - Assigns the specified aliases to the assigned users of the machine.

  • POST /inventory/v1/machines/{id}/action/assign-users - Assigns the specified users to the machine.

  • POST /inventory/v1/machines/{id}/action/attach-persistent-disk - Attaches the specified persistent disk to a machine.

  • POST /inventory/v1/machines/{id}/action/detach-persistent-disk - Detaches the specified persistent disk from a machine.

  • POST /inventory/v1/machines/{id}/action/unassign-aliases - Un-assigns the aliases for the specified users from the machine.

  • POST /inventory/v1/machines/{id}/action/unassign-users - Un-assigns the specified users from the machine.

  • POST /inventory/v1/machines/action/archive - Initiates machine archival process

  • POST /inventory/v1/machines/action/cancel-agent-upgrade - cancel agent upgrades.

  • POST /inventory/v1/machines/action/check-name-availability - Checks if the given prefix is available for machine creation.

  • POST /inventory/v1/machines/action/enter-maintenance - Puts the machines into maintenance mode.

  • POST /inventory/v1/machines/action/exit-maintenance - Puts the machines out of maintenance mode.

  • POST /inventory/v1/machines/action/rebuild - Rebuilds the specified machines.

  • POST /inventory/v1/machines/action/recover - Recovers the specified machines.

  • POST /inventory/v1/machines/action/recreate-from-persistent-disk - Recreates machines from the specified persistent disks.

  • POST /inventory/v1/machines/action/reset - Resets the specified machines.

  • POST /inventory/v1/machines/action/restart - Restarts the specified machines.

  • POST /inventory/v1/machines/action/schedule-agent-upgrade - Schedule agents for upgrade.

  • POST /inventory/v1/machines/action/set-golden-image - Sets the given unmanaged machines as golden images

  • POST /inventory/v1/machines/action/shutdown - Shutdown the specified machines.

  • POST /inventory/v1/persistent-disks - Creates a persistent disk.

  • POST /inventory/v1/physical-machines/action/register - Registers the Physical Machine.

  • POST /inventory/v1/physical-machines/action/set-golden-image - Sets the given unmanaged machines as golden images

  • POST /inventory/v1/rds-servers/action/cancel-agent-upgrade - cancel agent upgrades.

  • POST /inventory/v1/rds-servers/action/check-name-availability - Checks if the given prefix is available for RDS Server creation.

  • POST /inventory/v1/rds-servers/action/recover - Recovers the specified RDS Servers.

  • POST /inventory/v1/rds-servers/action/register - Registers the RDS Server.

  • POST /inventory/v1/rds-servers/action/schedule-agent-upgrade - Schedule agents for upgrade.

  • POST /inventory/v1/sessions/action/disconnect - Disconnects locally resourced user sessions.

  • POST /inventory/v1/sessions/action/logoff - Logs off locally resourced user sessions, if they are not locked.

  • POST /inventory/v1/sessions/action/reset - 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 /inventory/v1/sessions/action/restart - 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 /inventory/v1/sessions/action/send-message - Sends the message to locally resourced user sessions.

  • POST /inventory/v10/application-pools - Creates an application pool.

  • POST /inventory/v10/desktop-pools - Creates a desktop pool.

  • POST /inventory/v11/desktop-pools - Creates a desktop pool.

  • POST /inventory/v12/desktop-pools - Creates a desktop pool.

  • POST /inventory/v2/agent-installer-packages/action/register - Registers an agent installer package.

  • POST /inventory/v2/application-pools - Creates an application pool.

  • POST /inventory/v2/cp-desktop-pools - Creates a capacity provider desktop pool.

  • POST /inventory/v2/cp-farms - Creates a farm.

  • POST /inventory/v2/desktop-pools - Creates a desktop pool.

  • POST /inventory/v2/desktop-pools/{id}/action/schedule-push-image - Schedule/reschedule a request to update the image in an instant clone desktop pool.

  • POST /inventory/v2/farms - Creates a farm.

  • POST /inventory/v2/farms/{id}/action/schedule-maintenance - Creates maintenance schedule for the specified farm.

  • POST /inventory/v2/global-desktop-entitlements - Creates a Global Desktop Entitlement.

  • POST /inventory/v2/machines/action/schedule-agent-upgrade - Schedule agents for upgrade.

  • POST /inventory/v2/physical-machines/action/register - Registers the Physical Machine.

  • POST /inventory/v2/rds-servers/action/schedule-agent-upgrade - Schedule agents for upgrade.

  • POST /inventory/v3/application-pools - Creates an application pool.

  • POST /inventory/v3/cp-desktop-pools - Creates a capacity provider desktop pool.

  • POST /inventory/v3/desktop-pools/{id}/action/schedule-push-image - Schedule/reschedule a request to update the image in an instant clone desktop pool.

  • POST /inventory/v3/farms - Creates a farm.

  • POST /inventory/v3/farms/{id}/action/schedule-maintenance - Creates maintenance schedule for the specified farm.

  • POST /inventory/v3/global-application-entitlements - Creates a Global Application Entitlement.

  • POST /inventory/v3/global-desktop-entitlements - Creates a Global Desktop Entitlement.

  • POST /inventory/v3/machines/action/schedule-agent-upgrade - Schedule agents for upgrade.

  • POST /inventory/v4/desktop-pools/{id}/action/schedule-push-image - Schedule/reschedule a request to update the image in an instant clone desktop pool.

  • POST /inventory/v4/global-application-entitlements - Creates a Global Application Entitlement.

  • POST /inventory/v4/global-desktop-entitlements - Creates a Global Desktop Entitlement.

  • POST /inventory/v5/application-pools - Creates an application pool.

  • POST /inventory/v5/global-desktop-entitlements - Creates a Global Desktop Entitlement.

  • POST /inventory/v6/application-pools - Creates an application pool.

  • POST /inventory/v6/farms - Creates a farm.

  • POST /inventory/v6/global-application-entitlements - Creates a Global Application Entitlement.

  • POST /inventory/v6/global-desktop-entitlements - Creates a Global Desktop Entitlement.

  • POST /inventory/v7/application-pools - Creates an application pool.

  • POST /inventory/v7/desktop-pools - Creates a desktop pool.

  • POST /inventory/v7/farms - Creates a farm.

  • POST /inventory/v7/global-application-entitlements - Creates a Global Application Entitlement.

  • POST /inventory/v7/global-desktop-entitlements - Creates a Global Desktop Entitlement.

  • POST /inventory/v8/application-pools - Creates an application pool.

  • POST /inventory/v8/desktop-pools - Creates a desktop pool.

  • POST /inventory/v8/farms - Creates a farm.

  • POST /inventory/v9/application-pools - Creates an application pool.

  • POST /inventory/v9/desktop-pools - Creates a desktop pool.

  • POST /inventory/v9/farms - Creates a farm.

  • PUT /inventory/v1/application-pools/{id} - Updates application pool.

  • PUT /inventory/v1/cp-desktop-pools/{id} - Updates capacity provider desktop pool.

  • PUT /inventory/v1/cp-farms/{id} - Updates farm.

  • PUT /inventory/v1/desktop-pools/{id} - Updates desktop pool.

  • PUT /inventory/v1/desktop-pools/{id}/policies - Updates the policies on the given desktop pool.

  • PUT /inventory/v1/desktop-pools/{id}/policies/overrides - Updates policies overrides for users on the given desktop pool.

  • PUT /inventory/v1/farms/{id} - Updates farm.

  • PUT /inventory/v1/global-application-entitlements/{id} - Updates a Global Application Entitlement.

  • PUT /inventory/v1/global-desktop-entitlements/{id} - Updates a Global Desktop Entitlement.

  • PUT /inventory/v1/persistent-disks/{id} - Updates persistent disk.

  • PUT /inventory/v1/rds-servers/{id} - Updates the RDS Server.

  • PUT /inventory/v10/application-pools/{id} - Updates application pool.

  • PUT /inventory/v10/desktop-pools/{id} - Updates desktop pool.

  • PUT /inventory/v11/desktop-pools/{id} - Updates desktop pool.

  • PUT /inventory/v12/desktop-pools/{id} - Updates desktop pool.

  • PUT /inventory/v2/application-pools/{id} - Updates application pool.

  • PUT /inventory/v2/cp-desktop-pools/{id} - Updates capacity provider desktop pool.

  • PUT /inventory/v2/cp-farms/{id} - Updates farm.

  • PUT /inventory/v2/farms/{id} - Updates farm.

  • PUT /inventory/v2/rds-servers/{id} - Updates the RDS Server.

  • PUT /inventory/v3/application-pools/{id} - Updates application pool.

  • PUT /inventory/v3/cp-desktop-pools/{id} - Updates capacity provider desktop pool.

  • PUT /inventory/v3/farms/{id} - Updates farm.

  • PUT /inventory/v3/global-application-entitlements/{id} - Updates a Global Application Entitlement.

  • PUT /inventory/v3/global-desktop-entitlements/{id} - Updates a Global Desktop Entitlement.

  • PUT /inventory/v3/physical-machines/{id} - Updates the physical machine.

  • PUT /inventory/v3/rds-servers/{id} - Updates the RDS Server.

  • PUT /inventory/v4/global-application-entitlements/{id} - Updates a Global Application Entitlement.

  • PUT /inventory/v4/global-desktop-entitlements/{id} - Updates a Global Desktop Entitlement.

  • PUT /inventory/v4/physical-machines/{id} - Updates the physical machine.

  • PUT /inventory/v4/rds-servers/{id} - Updates the RDS Server.

  • PUT /inventory/v5/application-pools/{id} - Updates application pool.

  • PUT /inventory/v5/global-desktop-entitlements/{id} - Updates a Global Desktop Entitlement.

  • PUT /inventory/v5/physical-machines/{id} - Updates the physical machine.

  • PUT /inventory/v5/rds-servers/{id} - Updates the RDS Server.

  • PUT /inventory/v6/application-pools/{id} - Updates application pool.

  • PUT /inventory/v6/farms/{id} - Updates farm.

  • PUT /inventory/v6/global-application-entitlements/{id} - Updates a Global Application Entitlement.

  • PUT /inventory/v6/global-desktop-entitlements/{id} - Updates a Global Desktop Entitlement.

  • PUT /inventory/v7/application-pools/{id} - Updates application pool.

  • PUT /inventory/v7/desktop-pools/{id} - Updates desktop pool.

  • PUT /inventory/v7/farms/{id} - Updates farm.

  • PUT /inventory/v7/global-application-entitlements/{id} - Updates a Global Application Entitlement.

  • PUT /inventory/v7/global-desktop-entitlements/{id} - Updates a Global Desktop Entitlement.

  • PUT /inventory/v7/rds-servers/{id} - Updates the RDS Server.

  • PUT /inventory/v8/application-pools/{id} - Updates application pool.

  • PUT /inventory/v8/desktop-pools/{id} - Updates desktop pool.

  • PUT /inventory/v8/farms/{id} - Updates farm.

  • PUT /inventory/v9/application-pools/{id} - Updates application pool.

  • PUT /inventory/v9/desktop-pools/{id} - Updates desktop pool.

  • PUT /inventory/v9/farms/{id} - Updates farm.


Configuration Endpoints


  • DELETE /config/v1/app-volumes-manager/{id} - deletes the given app volumes manager

  • DELETE /config/v1/compute-profiles/{id} - Deletes a Compute Profile.

  • DELETE /config/v1/connection-servers/action/certificates - Deletes both Machine and Cluster SSL certificates of connection server.

  • DELETE /config/v1/customization-specifications/{id} - Deletes a Customization Specification.

  • DELETE /config/v1/external-deployments/{id} - Deletes the given external deployment

  • DELETE /config/v1/federation-access-groups/{id} - Deletes a federation access group.

  • DELETE /config/v1/gateway-access-users-or-groups - Deletes a specified gateway access user or group in the environment.

  • DELETE /config/v1/gateways/{id} - Unregister gateway.

  • DELETE /config/v1/gateways/certificates/{id} - Deletes the gateway certificate.

  • DELETE /config/v1/gssapi-authenticators/{id} - Deletes a GSSAPI Authenticator.

  • DELETE /config/v1/ic-domain-accounts/{id} - Deletes instant clone domain account.

  • DELETE /config/v1/im-assets/{id} - Deletes image management asset.

  • DELETE /config/v1/im-streams/{id} - Deletes image management stream.

  • DELETE /config/v1/im-tags/{id} - Deletes image management tag.

  • DELETE /config/v1/im-versions/{id} - Deletes image management version.

  • DELETE /config/v1/jwt-authenticators/{id} - Deletes the given JWT authenticator.

  • DELETE /config/v1/local-access-groups/{id} - Deletes a local access group.

  • DELETE /config/v1/message-clients/{id} - Deletes a message client.

  • DELETE /config/v1/permissions - Deletes permissions in bulk.

  • DELETE /config/v1/radius-authenticators/{id} - Deletes the given RADIUS Authenticator.

  • DELETE /config/v1/rcx/clients/{id} - Unregisters the given RCX Client

  • DELETE /config/v1/roles/{id} - Deletes a role.

  • DELETE /config/v1/saml-authenticators/{id} - Deletes a SAML Authenticator.

  • DELETE /config/v1/secondary-credentials/{id} - Deletes a secondary credential.

  • DELETE /config/v1/true-sso-enrollment-servers/{id} - Removes a paired TrueSSO Enrollment Server.

  • DELETE /config/v1/true-sso/{id} - Deletes a TrueSSO Connector.

  • DELETE /config/v1/uem-servers/{id} - deletes the given UEM Server.

  • DELETE /config/v1/unauthenticated-access-users/{id} - Deletes a specified unauthenticated access user in the environment.

  • DELETE /config/v1/url-redirection/{id} - Delete the URL Setting Information.

  • DELETE /config/v2/app-volumes-manager/{id} - Deletes the given app volumes manager.

  • DELETE /config/v2/jwt-authenticators/{id} - Deletes the given JWT authenticator.

  • DELETE /config/v2/permissions - Deletes permissions in bulk.

  • DELETE /config/v2/saml-authenticators/{id} - Deletes a SAML Authenticator.

  • DELETE /config/v3/permissions - Deletes permissions in bulk.

  • DELETE /config/v3/saml-authenticators/{id} - Deletes a SAML Authenticator.

  • DELETE /config/v3/virtual-centers/{id} - Removes a Virtual Center from the server

  • DELETE /config/v5/virtual-centers/{id} - Removes a Virtual Center from the server

  • GET /config/v1/admin-users-or-groups/permissions - Gets permission information for logged in or other admin user or group.

  • GET /config/v1/admin-users-or-groups/preferences - Gets Horizon Console preferences for the logged in administrator.

  • GET /config/v1/app-volumes-manager - Lists the configured app volumes managers.

  • GET /config/v1/app-volumes-manager/{id} - Retrieves information about an app volumes manager.

  • GET /config/v1/ceip - Get the CEIP Information.

  • GET /config/v1/compute-profiles - Lists the configured compute profiles.

  • GET /config/v1/compute-profiles/{id} - Retrieves information about a Compute Profile.

  • GET /config/v1/connection-servers - Lists the connection servers.

  • GET /config/v1/connection-servers/{id} - Retrieves information about a connection server.

  • GET /config/v1/connection-servers/certificates - Retrieves the certificate details.

  • GET /config/v1/connection-servers/security-configuration - Retrieves the security configuration of connection server and secure gateway

  • GET /config/v1/customization-specifications - Lists the Customization Specifications.

  • GET /config/v1/customization-specifications/{id} - Retrieves information about a Customization Specification.

  • GET /config/v1/environment-properties - Retrieves the environment settings.

  • GET /config/v1/event-database - Returns information about event database configuration.

  • GET /config/v1/external-deployments - Lists the configured external deployments.

  • GET /config/v1/external-deployments/{id} - Retrieves information about an external deployment.

  • GET /config/v1/federation-access-groups - Lists all federation access groups.

  • GET /config/v1/federation-access-groups/{id} - Retrieves a federation access group.

  • GET /config/v1/gateway-access-users-or-groups - Lists gateway access users or group in the environment.

  • GET /config/v1/gateways - Lists the registered gateways.

  • GET /config/v1/gateways/{id} - Retrieves information about a registered gateway.

  • GET /config/v1/gateways/certificates - Lists the information of the gateway certificates.

  • GET /config/v1/global-policies - Returns the global policies in the environment.

  • GET /config/v1/gssapi-authenticators - Lists the configured GSSAPI Authenticators.

  • GET /config/v1/gssapi-authenticators/{id} - Retrieves information about a GSSAPI Authenticator.

  • GET /config/v1/ic-domain-accounts - Lists instant clone domain accounts of the environment.

  • GET /config/v1/ic-domain-accounts/{id} - Gets instant clone domain account.

  • GET /config/v1/ic-domain-accounts/{id}/ad_sites - Get all the available AD sites for the instant clone domain account.

  • GET /config/v1/im-assets - Lists image management assets.

  • GET /config/v1/im-assets/{id} - Gets image management asset.

  • GET /config/v1/im-streams - Lists image management streams.

  • GET /config/v1/im-streams/{id} - Gets image management stream.

  • GET /config/v1/im-tags - Lists image management tags.

  • GET /config/v1/im-tags/{id} - Gets image management tag.

  • GET /config/v1/im-versions - Lists image management versions.

  • GET /config/v1/im-versions/{id} - Gets image management version.

  • GET /config/v1/jwt-authenticators - Lists the configured JWT authenticators.

  • GET /config/v1/jwt-authenticators/{id} - Retrieves information about the given JWT authenticator.

  • GET /config/v1/licenses - Lists all licenses.

  • GET /config/v1/local-access-groups - Lists all local access groups.

  • GET /config/v1/local-access-groups/{id} - Retrieves a local access group.

  • GET /config/v1/log-collector/log-levels - Fetches feature wise log level information for a component.

  • GET /config/v1/log-collector/tasks - Lists Log Collector task information

  • GET /config/v1/message-clients - Lists the message clients in the environment.

  • GET /config/v1/message-clients/{id} - Retrieves a message client.

  • GET /config/v1/permissions - Lists all permissions.

  • GET /config/v1/permissions/{id} - Retrieves a permission.

  • GET /config/v1/pre-logon-settings - Gets the pre logon settings.

  • GET /config/v1/privileges - Lists all selectable privileges.

  • GET /config/v1/radius-authenticators - Lists the configured RADIUS Authenticators.

  • GET /config/v1/radius-authenticators/{id} - Retrieves information about a RADIUS Authenticator.

  • GET /config/v1/rcx/servers - Lists RCX servers of the cluster.

  • GET /config/v1/roles - Lists all roles.

  • GET /config/v1/roles/{id} - Retrieves a role.

  • GET /config/v1/saml-authenticators - Lists the configured SAML authenticators.

  • GET /config/v1/saml-authenticators/{id} - Retrieves information about a SAML authenticator.

  • GET /config/v1/secondary-credentials - List the configured Secondary Credentials for given user.

  • GET /config/v1/secondary-credentials/{id} - Get the configured secondary credentials for given id.

  • GET /config/v1/settings - Retrieves the configuration settings.

  • GET /config/v1/settings/agent-restriction-settings - Retrieves the agent restriction settings.

  • GET /config/v1/settings/client-settings - Retrieves the client settings.

  • GET /config/v1/settings/feature - Retrieves the feature settings.

  • GET /config/v1/settings/general - Retrieves the general settings.

  • GET /config/v1/settings/security - Retrieves the security settings.

  • GET /config/v1/syslog - Gets Syslog information

  • GET /config/v1/true-sso - Lists the TrueSSO Connectors.

  • GET /config/v1/true-sso-enrollment-servers - Lists the paired TrueSSO Enrollment Servers.

  • GET /config/v1/true-sso-enrollment-servers/{id} - Retrieves information about a paired TrueSSO Enrollment Server.

  • GET /config/v1/true-sso/{id} - Retrieves information about a requested TrueSSO Connector.

  • GET /config/v1/uem-servers - Lists the configured UEM servers.

  • GET /config/v1/uem-servers/{id} - Retrieves information about UEM Server.

  • GET /config/v1/unauthenticated-access-users - Lists unauthenticated access users in the environment.

  • GET /config/v1/unauthenticated-access-users/{id} - Retrieves a specified unauthenticated access user in the environment.

  • GET /config/v1/url-redirection - Lists the URL Setting Information.

  • GET /config/v1/url-redirection/{id} - Get the URL Setting Information.

  • GET /config/v1/users-or-groups-global-summary - Lists global summary info of users or groups.

  • GET /config/v1/users-or-groups-global-summary/{id} - Gets global summary info related to AD User or Group.

  • GET /config/v1/users-or-groups-local-summary - Lists local summary info of users or groups.

  • GET /config/v1/virtual-centers - Lists Virtual Centers configured in the environment.

  • GET /config/v10/settings - Retrieves the configuration settings.

  • GET /config/v11/settings - Retrieves the configuration settings.

  • GET /config/v2/admin-users-or-groups/preferences - Gets Horizon Console preferences for the logged in administrator.

  • GET /config/v2/app-volumes-manager - Lists the configured app volumes managers.

  • GET /config/v2/app-volumes-manager/{id} - Retrieves information about an app volumes manager.

  • GET /config/v2/connection-servers - Lists the connection servers.

  • GET /config/v2/connection-servers/{id} - Retrieves information about a connection server.

  • GET /config/v2/connection-servers/certificates - Retrieves the certificate details.

  • GET /config/v2/environment-properties - Retrieves the environment settings.

  • GET /config/v2/event-database - Returns information about event database configuration.

  • GET /config/v2/federation-access-groups - Lists all federation access groups.

  • GET /config/v2/federation-access-groups/{id} - Retrieves a federation access group.

  • GET /config/v2/ic-domain-accounts - Lists instant clone domain accounts of the environment.

  • GET /config/v2/ic-domain-accounts/{id} - Gets instant clone domain account.

  • GET /config/v2/jwt-authenticators - Lists the configured JWT authenticators.

  • GET /config/v2/jwt-authenticators/{id} - Retrieves information about the given JWT authenticator.

  • GET /config/v2/licenses - Lists all licenses.

  • GET /config/v2/local-access-groups - Lists all local access groups.

  • GET /config/v2/local-access-groups/{id} - Retrieves a local access group.

  • GET /config/v2/permissions - Lists all permissions.

  • GET /config/v2/permissions/{id} - Retrieves a permission.

  • GET /config/v2/saml-authenticators - Lists the configured SAML authenticators.

  • GET /config/v2/saml-authenticators/{id} - Retrieves information about a SAML authenticator.

  • GET /config/v2/settings - Retrieves the configuration settings.

  • GET /config/v2/settings/client-settings - Retrieves the client settings.

  • GET /config/v2/settings/feature - Retrieves the feature settings.

  • GET /config/v2/settings/general - Retrieves the general settings.

  • GET /config/v2/settings/security - Retrieves the security settings.

  • GET /config/v2/users-or-groups-local-summary - Lists local summary info of users or groups.

  • GET /config/v2/users-or-groups-local-summary/{id} - Gets local summary info related to AD User or Group.

  • GET /config/v2/virtual-centers - Lists Virtual Centers configured in the environment.

  • GET /config/v3/connection-servers - Lists the connection servers.

  • GET /config/v3/connection-servers/{id} - Retrieves information about a connection server.

  • GET /config/v3/environment-properties - Retrieves the environment settings.

  • GET /config/v3/licenses - Lists all licenses.

  • GET /config/v3/permissions - Lists all permissions.

  • GET /config/v3/permissions/{id} - Retrieves a permission.

  • GET /config/v3/saml-authenticators - Lists the configured SAML authenticators.

  • GET /config/v3/saml-authenticators/{id} - Retrieves information about a SAML authenticator.

  • GET /config/v3/settings - Retrieves the configuration settings.

  • GET /config/v3/settings/feature - Retrieves the feature settings.

  • GET /config/v3/settings/general - Retrieves the general settings.

  • GET /config/v3/settings/security - Retrieves the security settings.

  • GET /config/v3/users-or-groups-local-summary - Lists local summary info of users or groups.

  • GET /config/v3/users-or-groups-local-summary/{id} - Gets local summary info related to AD User or Group.

  • GET /config/v3/virtual-centers - Lists Virtual Centers configured in the environment.

  • GET /config/v3/virtual-centers/{id} - Gets Virtual Center Information.

  • GET /config/v4/licenses - Lists all licenses.

  • GET /config/v4/settings - Retrieves the configuration settings.

  • GET /config/v4/settings/feature - Retrieves the feature settings.

  • GET /config/v4/settings/general - Retrieves the general settings.

  • GET /config/v4/settings/security - Retrieves the security settings.

  • GET /config/v4/users-or-groups-local-summary - Lists local summary info of users or groups.

  • GET /config/v4/users-or-groups-local-summary/{id} - Gets local summary info related to AD User or Group.

  • GET /config/v4/virtual-centers - Lists Virtual Centers configured in the environment.

  • GET /config/v4/virtual-centers/{id} - Gets Virtual Center Information.

  • GET /config/v5/settings - Retrieves the configuration settings.

  • GET /config/v5/settings/feature - Retrieves the feature settings.

  • GET /config/v5/settings/general - Retrieves the general settings.

  • GET /config/v5/settings/security - Retrieves the security settings.

  • GET /config/v5/users-or-groups-local-summary - Lists local summary info of users or groups.

  • GET /config/v5/users-or-groups-local-summary/{id} - Gets local summary info related to AD User or Group.

  • GET /config/v5/virtual-centers - Lists Virtual Centers configured in the environment.

  • GET /config/v5/virtual-centers/{id} - Gets Virtual Center Information.

  • GET /config/v6/settings - Retrieves the configuration settings.

  • GET /config/v6/settings/general - Retrieves the general settings.

  • GET /config/v6/settings/security - Retrieves the security settings.

  • GET /config/v6/virtual-centers - Lists Virtual Centers configured in the environment.

  • GET /config/v7/settings - Retrieves the configuration settings.

  • GET /config/v7/settings/general - Retrieves the general settings.

  • GET /config/v8/settings - Retrieves the configuration settings.

  • GET /config/v9/settings - Retrieves the configuration settings.

  • POST /config/v1/app-volumes-manager - Add the app volumes manager

  • POST /config/v1/app-volumes-manager/{id}/action/assign-farms - Assign Farms to App Volumes Manager

  • POST /config/v1/app-volumes-manager/{id}/action/override-certificate - Override the given app volumes manager certificate.

  • POST /config/v1/app-volumes-manager/{id}/action/push-certificates - Push cluster certificates to App Volumes Manager

  • POST /config/v1/app-volumes-manager/action/unassign-farms - Unassign Farms to App Volumes Manager

  • POST /config/v1/app-volumes-manager/action/validate-certificate - Validates App Volumes manager certificate.

  • POST /config/v1/compute-profiles - Creates a Compute Profile.

  • POST /config/v1/connection-servers/action/backup - Initiates immediate back up of Connection Servers

  • POST /config/v1/connection-servers/action/disable - Disables the given list of connection server ids.

  • POST /config/v1/connection-servers/action/enable - Enables the given list of connection server ids.

  • POST /config/v1/connection-servers/action/export-certificate - Exports the in-use certificate of connection server

  • POST /config/v1/connection-servers/action/generate-csr - Generate Certificate Signing Request(CSR).

  • POST /config/v1/connection-servers/action/import-certificate - Imports both Machine and Cluster SSL certificate to connection server's certificate store.

  • POST /config/v1/connection-servers/action/recover-certificates - Recover the deleted certificates.

  • POST /config/v1/customization-specifications - Creates a Customization Specification.

  • POST /config/v1/event-database/action/clear - Deletes event database configuration.

  • POST /config/v1/external-deployments - Add the external deployment

  • POST /config/v1/external-deployments/action/refresh-keys - Refreshes public keys for external deployment feature.

  • POST /config/v1/external-deployments/action/validate-certificate - Validates External Deployment connection server certificate.

  • POST /config/v1/federation-access-groups - Creates federation access group.

  • POST /config/v1/gateway-access-users-or-groups - Creates a specified gateway access user or group in the environment.

  • POST /config/v1/gateways - Register gateway.

  • POST /config/v1/gateways/certificates - Add the gateway certificate.

  • POST /config/v1/gssapi-authenticators - Creates a GSSAPI authenticator.

  • POST /config/v1/ic-domain-accounts - Creates instant clone domain account.

  • POST /config/v1/im-assets - Creates image management asset.

  • POST /config/v1/im-assets/action/bulk-create - 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 /config/v1/im-streams - Creates image management stream.

  • POST /config/v1/im-streams/action/bulk-create - 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 /config/v1/im-tags - Creates image management tag.

  • POST /config/v1/im-tags/action/bulk-create - 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 /config/v1/im-versions - Creates image management version.

  • POST /config/v1/im-versions/action/bulk-create - 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 /config/v1/jwt-authenticators - Creates a JWT authenticator.

  • POST /config/v1/jwt-authenticators/{id}/action/associate-connection-servers - Associates JWT authenticator with multiple connection servers.

  • POST /config/v1/jwt-authenticators/{id}/action/dissociate-connection-servers - Dissociate JWT authenticator with multiple connection servers.

  • POST /config/v1/licenses/action/reset-highest-usage-metrics - The highest historical number of concurrent connections will be reset to the current number.

  • POST /config/v1/licenses/action/reset-named-user-metrics - The highest historical number of named users will be reset to zero.

  • POST /config/v1/licenses/action/set-mode - Set the License Mode

  • POST /config/v1/licenses/action/validate - Validates the License Key

  • POST /config/v1/local-access-groups - Creates local access group.

  • POST /config/v1/log-collector/action/collect - Sends the log collection request for the set of targets

  • POST /config/v1/log-collector/tasks/action/clean - A finish acknowledgement to notify the connection server for cleanup of collect complete log bundles or to terminate the collect operation if is in progress of collecting logs bundle.

  • POST /config/v1/log-collector/tasks/action/generate-download-urls - Retrieves Download URL for each of specified log collector task.

  • POST /config/v1/log-collector/tasks/action/purge - Purges the log collection bundle for the provided list of targets.

  • POST /config/v1/message-clients - Creates a Message Client.

  • POST /config/v1/permissions - Creates permissions in bulk.

  • POST /config/v1/radius-authenticators - Creates a RADIUS Authenticator.

  • POST /config/v1/rcx/clients - Registers the RCX client

  • POST /config/v1/roles - Creates a role.

  • POST /config/v1/saml-authenticators - Creates a SAML authenticator.

  • POST /config/v1/saml-authenticators/{id}/action/associate-connection-servers - Associates SAML authenticator with multiple connection servers with specified state.

  • POST /config/v1/saml-authenticators/{id}/action/dissociate-connection-servers - Dissociate SAML authenticator with multiple connection servers.

  • POST /config/v1/saml-authenticators/action/validate-certificate - Validates SAML Authenticator certificate.

  • POST /config/v1/secondary-credentials - Creates secondary credential.

  • POST /config/v1/secondary-credentials/{id}/action/update-password - Update password.

  • POST /config/v1/true-sso - Creates a TrueSSO Connector.

  • POST /config/v1/true-sso-enrollment-servers - Add a TrueSSO Enrollment Server.

  • POST /config/v1/uem-servers - Add the UEM Server

  • POST /config/v1/unauthenticated-access-users - Creates a specified unauthenticated access user in the environment.

  • POST /config/v1/url-redirection - Creates a URL Redirection setting

  • POST /config/v1/virtual-center/action/get-storage-details - Gets Storage Details Information.

  • POST /config/v1/virtual-centers/{id}/action/mark-datastores-for-archival - Sets archival datastore paths for the vCenter.

  • POST /config/v1/virtual-centers/action/validate-certificate - Validates Virtual Center certificate.

  • POST /config/v2/app-volumes-manager - Add the app volumes manager.

  • POST /config/v2/event-database/action/clear - Deletes event database configuration.

  • POST /config/v2/event-database/action/validate-service-account - Validates service account credentials.

  • POST /config/v2/jwt-authenticators - Creates a JWT authenticator.

  • POST /config/v2/licenses - Set the License Key

  • POST /config/v2/permissions - Creates permissions in bulk.

  • POST /config/v2/saml-authenticators - Creates a SAML authenticator.

  • POST /config/v3/licenses - Set the License Key

  • POST /config/v3/permissions - Creates permissions in bulk.

  • POST /config/v3/saml-authenticators - Creates a SAML authenticator.

  • POST /config/v3/virtual-centers - Creates a virtual center

  • POST /config/v4/licenses - Set the License Key

  • POST /config/v4/virtual-centers - Creates a virtual center

  • POST /config/v5/virtual-centers - Creates a virtual center

  • PUT /config/v1/admin-users-or-groups/preferences - Updates the Horizon Console preferences for the logged in administrator.

  • PUT /config/v1/app-volumes-manager/{id} - Updates the given app volumes manager.

  • PUT /config/v1/ceip - Update the CEIP Information.

  • PUT /config/v1/compute-profiles/{id} - Updates a Compute Profile.

  • PUT /config/v1/connection-servers/{id} - Updates the settings of the given Connection Server.

  • PUT /config/v1/customization-specifications/{id} - Updates a Customization Specification.

  • PUT /config/v1/event-database - Updates event database configuration.

  • PUT /config/v1/external-deployments/{id} - Updates the given external deployment.

  • PUT /config/v1/global-policies - Updates the global policies in the environment.

  • PUT /config/v1/gssapi-authenticators/{id} - Updates a GSSAPI Authenticator.

  • PUT /config/v1/ic-domain-accounts/{id} - Updates instant clone domain account.

  • PUT /config/v1/im-assets/{id} - Updates image management asset.

  • PUT /config/v1/im-streams/{id} - Updates image management stream.

  • PUT /config/v1/im-tags/{id} - Updates image management tag.

  • PUT /config/v1/im-versions/{id} - Updates image management version.

  • PUT /config/v1/jwt-authenticators/{id} - Updates the given JWT authenticator.

  • PUT /config/v1/log-collector/log-levels - Updates feature specific log level for a component.

  • PUT /config/v1/message-clients/{id} - Updates message client.

  • PUT /config/v1/radius-authenticators/{id} - Updates the given RADIUS Authenticator.

  • PUT /config/v1/rcx/clients/{id} - Updates the given RCX client.

  • PUT /config/v1/roles/{id} - Updates a role.

  • PUT /config/v1/saml-authenticators/{id} - Updates a SAML Authenticator.

  • PUT /config/v1/settings - Updates the configuration settings.

  • PUT /config/v1/settings/agent-restriction-settings - Updates the agent restriction settings.

  • PUT /config/v1/settings/client-settings - Updates the client settings.

  • PUT /config/v1/settings/feature - Updates the feature settings.

  • PUT /config/v1/settings/general - Updates the general settings.

  • PUT /config/v1/settings/security - Updates the security settings.

  • PUT /config/v1/syslog - Updates Syslog configuration.

  • PUT /config/v1/true-sso/{id} - Updates a TrueSSO Connector.

  • PUT /config/v1/uem-servers/{id} - Updates the given UEM Server.

  • PUT /config/v1/unauthenticated-access-users/{id} - Updates a specified unauthenticated access user in the environment.

  • PUT /config/v1/url-redirection/{id} - updates the URL Setting Information.

  • PUT /config/v10/settings - Updates the configuration settings.

  • PUT /config/v11/settings - Updates the configuration settings.

  • PUT /config/v2/admin-users-or-groups/preferences - Updates the Horizon Console preferences for the logged in administrator.

  • PUT /config/v2/app-volumes-manager/{id} - Updates the given app volumes manager.

  • PUT /config/v2/connection-servers/{id} - Updates the settings of the given Connection Server.

  • PUT /config/v2/event-database - Updates event database configuration.

  • PUT /config/v2/jwt-authenticators/{id} - Updates the given JWT authenticator.

  • PUT /config/v2/saml-authenticators/{id} - Updates a SAML Authenticator.

  • PUT /config/v2/settings - Updates the configuration settings.

  • PUT /config/v2/settings/client-settings - Updates the client settings.

  • PUT /config/v2/settings/feature - Updates the feature settings.

  • PUT /config/v2/settings/general - Updates the general settings.

  • PUT /config/v3/connection-servers/{id} - Updates the settings of the given Connection Server.

  • PUT /config/v3/saml-authenticators/{id} - Updates a SAML Authenticator.

  • PUT /config/v3/settings - Updates the configuration settings.

  • PUT /config/v3/settings/feature - Updates the feature settings.

  • PUT /config/v3/settings/general - Updates the general settings.

  • PUT /config/v3/settings/security - Updates the security settings.

  • PUT /config/v3/virtual-centers/{id} - Updates virtual center.

  • PUT /config/v4/settings - Updates the configuration settings.

  • PUT /config/v4/settings/feature - Updates the feature settings.

  • PUT /config/v4/settings/general - Updates the general settings.

  • PUT /config/v4/settings/security - Updates the security settings.

  • PUT /config/v4/virtual-centers/{id} - Updates virtual center.

  • PUT /config/v5/settings - Updates the configuration settings.

  • PUT /config/v5/settings/feature - Updates the feature settings.

  • PUT /config/v5/settings/general - Updates the general settings.

  • PUT /config/v5/settings/security - Updates the security settings.

  • PUT /config/v5/virtual-centers/{id} - Updates virtual center.

  • PUT /config/v6/settings - Updates the configuration settings.

  • PUT /config/v6/settings/general - Updates the general settings.

  • PUT /config/v6/settings/security - Updates the security settings.

  • PUT /config/v7/settings - Updates the configuration settings.

  • PUT /config/v7/settings/general - Updates the general settings.

  • PUT /config/v8/settings - Updates the configuration settings.

  • PUT /config/v9/settings - Updates the configuration settings.


Monitoring Endpoints


  • GET /monitor/ad-domains - Lists monitoring information related to AD Domains of the environment.

  • GET /monitor/app-volumes-managers - Lists monitoring information related to App volumes managers registered in the environment.

  • GET /monitor/app-volumes-managers/{id} - Retrieves information about an app volumes manager.

  • GET /monitor/connection-servers - Lists monitoring information related to Connection Servers of the environment.

  • GET /monitor/desktops - Lists monitoring information related to desktop pools in the environment.

  • GET /monitor/event-database - Returns monitoring information related to Event database of the environment.

  • GET /monitor/farms - Lists monitoring information related to Farms of the environment.

  • GET /monitor/gateways - Lists monitoring information related to Gateways registered in the environment.

  • GET /monitor/rds-servers - Lists monitoring information related to RDS Servers of the environment.

  • GET /monitor/saml-authenticators - Lists monitoring information related to SAML Authenticators of the environment.

  • GET /monitor/v1/connection-servers/{id} - Gets monitoring information related to Connection Server.

  • GET /monitor/v1/connection-servers/schema-master - Lists monitoring information related to current schema master of the environment.

  • GET /monitor/v1/datastores/usage-metrics - Lists the Desktop pool or Farm and its usage details for a given datastore.

  • GET /monitor/v1/desktop-pools/metrics - Lists metrics of desktop pools (except RDS desktop pools).

  • GET /monitor/v1/desktops/{id} - Retrieves information related to a desktop pool.

  • GET /monitor/v1/farms/{id} - Gets monitoring information related to farm.

  • GET /monitor/v1/gateways/{id} - Gets monitoring information related to a Gateway.

  • GET /monitor/v1/global-desktop-entitlements/metrics - Lists metrics of global desktop entitlements.

  • GET /monitor/v1/health-metrics - Lists the health metrics related information for all the components.

  • GET /monitor/v1/licenses/usage-metrics - Get metrics of current and highest historical usage numbers of the product license.

  • GET /monitor/v1/machines/count-metrics - Gets the state count metrics of the machines.

  • GET /monitor/v1/message-clients - Lists monitoring information related to registered message clients in the environment.

  • GET /monitor/v1/message-clients/{id} - Gets monitoring information related to registered message client.

  • GET /monitor/v1/pods - Lists monitoring information related to the remote pods.

  • GET /monitor/v1/pods/{id} - Gets monitoring information related to the remote pod.

  • GET /monitor/v1/pods/global-session-metrics - Get the global session counts related to all Pods in the Pod Federation.

  • GET /monitor/v1/rds-servers/{id} - Gets monitoring information related to RDS Server.

  • GET /monitor/v1/rds-servers/count-metrics - Gets State Counts related to RDS Server.

  • GET /monitor/v1/saml-authenticators/{id} - Gets Monitoring Information related to a SAML Authenticator

  • GET /monitor/v1/sessions/metrics - Gets summary of local session metrics.

  • GET /monitor/v1/system-metrics - Gets the system metrics of all the components.

  • GET /monitor/v1/true-sso - Lists monitoring information related to True SSO connectors.

  • GET /monitor/v1/true-sso/{id} - Gets monitoring information related to a True SSO connector.

  • GET /monitor/v1/view-composers/{vcId} - View Composer is no longer supported from Horizon version 2012 onwards.

  • GET /monitor/v1/virtual-centers/{id} - Gets monitoring information related to Virtual Center.

  • GET /monitor/v2/ad-domains - Lists monitoring information related to AD Domains of the environment.

  • GET /monitor/v2/app-volumes-managers - Lists monitoring information related to App volumes managers registered in the environment.

  • GET /monitor/v2/app-volumes-managers/{id} - Retrieves information about an app volumes manager.

  • GET /monitor/v2/connection-servers - Lists monitoring information related to Connection Servers of the environment.

  • GET /monitor/v2/connection-servers/{id} - Gets monitoring information related to Connection Server.

  • GET /monitor/v2/desktop-pools/metrics - Lists metrics of desktop pools (except RDS desktop pools).

  • GET /monitor/v2/desktops - Lists monitoring information related to desktop pools in the environment (except RDS desktop pools).

  • GET /monitor/v2/desktops/{id} - Retrieves information related to a desktop pool (except RDS desktop pools).

  • GET /monitor/v2/event-database - Returns monitoring information related to Event database of the environment.

  • GET /monitor/v2/farms - Lists monitoring data related to Farms of the environment.

  • GET /monitor/v2/farms/{id} - Gets monitoring data related to farm.

  • GET /monitor/v2/gateways - Lists monitoring information related to Gateways registered in the environment.

  • GET /monitor/v2/gateways/{id} - Gets monitoring information related to a Gateway.

  • GET /monitor/v2/machines/count-metrics - Gets the state count metrics of the machines.

  • GET /monitor/v2/pods - Lists monitoring information related to the remote pods.

  • GET /monitor/v2/rds-servers - Lists monitoring information related to RDS Servers of the environment.

  • GET /monitor/v2/rds-servers/{id} - Gets monitoring information related to RDS Server.

  • GET /monitor/v2/saml-authenticators - Lists monitoring information related to SAML Authenticators of the environment.

  • GET /monitor/v2/system-metrics - Gets the system metrics of all the components.

  • GET /monitor/v2/true-sso - Lists monitoring information related to True SSO connectors.

  • GET /monitor/v2/true-sso/{id} - Gets monitoring information related to a True SSO connector.

  • GET /monitor/v2/view-composers - View Composer is no longer supported from Horizon version 2012 onwards.

  • GET /monitor/v2/virtual-centers - Lists monitoring information related to Virtual Centers of the environment.

  • GET /monitor/v3/ad-domains - Lists monitoring information related to AD Domains of the environment.

  • GET /monitor/v3/connection-servers - Lists monitoring information related to Connection Servers of the environment.

  • GET /monitor/v3/desktop-pools/metrics - Lists metrics of desktop pools (except RDS desktop pools).

  • GET /monitor/v3/event-database - Returns monitoring information related to Event database of the environment.

  • GET /monitor/v3/gateways - Lists monitoring information related to Gateways registered in the environment.

  • GET /monitor/v3/rds-servers - Lists monitoring information related to RDS Servers of the environment.

  • GET /monitor/v3/rds-servers/{id} - Gets monitoring information related to RDS Server.

  • GET /monitor/v3/saml-authenticators - Lists monitoring information related to SAML Authenticators of the environment.

  • GET /monitor/v3/saml-authenticators/{id} - Gets Monitoring Information related to a SAML Authenticator

  • GET /monitor/v3/virtual-centers - Lists monitoring information related to Virtual Centers of the environment.

  • GET /monitor/v3/virtual-centers/{id} - Gets monitoring information related to Virtual Center.

  • GET /monitor/v4/ad-domains - Lists monitoring information related to AD Domains of the environment.

  • GET /monitor/v4/connection-servers - Lists monitoring information related to Connection Servers of the environment.

  • GET /monitor/v4/connection-servers/{id} - Gets monitoring information related to Connection Server.

  • GET /monitor/v4/gateways - Lists monitoring information related to Gateways registered in the environment.

  • GET /monitor/v4/gateways/{id} - Gets monitoring information related to a Gateway.

  • GET /monitor/v4/rds-servers - Lists monitoring information related to RDS Servers of the environment.

  • GET /monitor/v4/rds-servers/{id} - Gets monitoring information related to RDS Server.

  • GET /monitor/v4/saml-authenticators - Lists monitoring information related to SAML Authenticators of the environment.

  • GET /monitor/v4/saml-authenticators/{id} - Gets Monitoring Information related to a SAML Authenticator

  • GET /monitor/v4/virtual-centers - Lists monitoring information related to Virtual Centers of the environment.

  • GET /monitor/v4/virtual-centers/{id} - Gets monitoring information related to Virtual Center.

  • GET /monitor/v5/gateways - Lists monitoring information related to Gateways registered in the environment.

  • GET /monitor/v5/gateways/{id} - Gets monitoring information related to a Gateway.

  • GET /monitor/v5/virtual-centers - Lists monitoring information related to Virtual Centers of the environment.

  • GET /monitor/v5/virtual-centers/{id} - Gets monitoring information related to Virtual Center.

  • GET /monitor/view-composers - View Composer is no longer supported from Horizon version 2012 onwards.

  • GET /monitor/virtual-centers - Lists monitoring information related to Virtual Centers of the environment.


External Infrastructure Endpoints


  • DELETE /external/v1/capacity-providers/{id} - Removes a capacity provider

  • DELETE /external/v3/capacity-providers/{id} - Deletes a capacity provider.

  • GET /external/v1/ad-computers - Lists AD computer information.

  • GET /external/v1/ad-domains - Lists information related to AD Domains of the environment.

  • GET /external/v1/ad-domains/{id}/ad-containers - List active directory containers for a specific domain.

  • GET /external/v1/ad-domains/{id}/ad-containers/{rdn} - Gets the AD container for specified domain.

  • GET /external/v1/ad-domains/{id}/ad-containers/default - Get default AD container for specified domain.

  • GET /external/v1/ad-users-or-groups - Lists AD users or groups information.

  • GET /external/v1/ad-users-or-groups/{id} - Get information related to AD User or Group

  • GET /external/v1/ad-users-or-groups/held-users-or-groups - List information related to Held Users.

  • GET /external/v1/audit-events - Lists the audit events.

  • GET /external/v1/audit-events/agent-upgrade-history - Gets the agent upgrade history.

  • GET /external/v1/audit-events/extended-attributes - Get extended attributes of audit events

  • GET /external/v1/base-snapshots - Lists all the VM snapshots from the vCenter for a given VM.

  • GET /external/v1/base-vms - 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 /external/v1/capacity-providers - Lists capacity providers added in the environment.

  • GET /external/v1/capacity-providers/{id} - Gets capacity provider Information.

  • GET /external/v1/capacity-providers/{id}/aws-images - Lists all the images from AWS core for the specific capacity provider id

  • GET /external/v1/capacity-providers/{id}/bundles - Lists all the bundles from AWS core for the specific capacity provider id

  • GET /external/v1/capacity-providers/{id}/directories - Lists all the directories from AWS core for the specific capacity provider id

  • GET /external/v1/capacity-providers/{id}/images - Retrieves images available with the capacity provider.

  • GET /external/v1/capacity-providers/{id}/networks - Lists all the networks of the specific capacity provider id.

  • GET /external/v1/capacity-providers/{id}/resource-containers - Lists all the Resource Containers of the specific capacity provider id.

  • GET /external/v1/capacity-providers/aws-core/regions - Lists all the regions from AWS core

  • GET /external/v1/customization-specifications - Lists all the customization specifications from the vCenter.

  • GET /external/v1/datacenters - Lists all the datacenters of a vCenter.

  • GET /external/v1/datastore-clusters - Lists all the datastore clusters from the vCenter for the given host or cluster.

  • GET /external/v1/datastore-paths - Lists all the folder paths within a Datastore from vCenter.

  • GET /external/v1/datastores - Lists all the datastores from the vCenter for the given host or cluster.

  • GET /external/v1/domains - Returns a map of domain NETBIOS name and dns name for domains which are configured on connection server.

  • GET /external/v1/hosts-or-clusters - Lists all the hosts or clusters of the datacenter.

  • GET /external/v1/network-interface-cards - Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.

  • GET /external/v1/network-labels - Retrieves all network labels on the given host or cluster

  • GET /external/v1/resource-pools - Lists all the resource pools from the vCenter for the given host or cluster.

  • GET /external/v1/virtual-disks - Lists Virtual disks from vCenter for a given datastore. If datastore_id is not specified, it lists the Virtual Disks for all datastores. If populate_all_disks is set to true, all virtual disks will be populated.

  • GET /external/v1/virtual-machines - Lists all the VMs from a vCenter.

  • GET /external/v1/vm-folders - Lists all the VM folders from the vCenter for the given datacenter.

  • GET /external/v1/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.

  • GET /external/v2/ad-domains - Lists information related to AD Domains of the environment.

  • GET /external/v2/ad-users-or-groups/{id} - Get information related to AD User or Group

  • GET /external/v2/audit-events - Lists the audit events.

  • GET /external/v2/audit-events/agent-upgrade-history - Gets the agent upgrade history.

  • GET /external/v2/base-snapshots - Lists all the VM snapshots from the vCenter for a given VM.

  • GET /external/v2/base-vms - 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 /external/v2/base-vms/{id} - Gets the specified VM information

  • GET /external/v2/capacity-providers - Lists capacity providers added in the environment.

  • GET /external/v2/capacity-providers/{id} - Gets capacity provider Information.

  • GET /external/v2/network-interface-cards - Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.

  • GET /external/v2/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.

  • GET /external/v3/ad-domains - Lists information related to AD Domains of the environment.

  • GET /external/v3/audit-events/agent-upgrade-history - Gets the agent upgrade history.

  • GET /external/v3/base-snapshots - Lists all the VM snapshots from the vCenter for a given VM.

  • GET /external/v3/base-vms - 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 /external/v3/capacity-providers - Lists capacity providers.

  • GET /external/v3/capacity-providers/{id} - Retrieves a capacity provider.

  • GET /external/v4/ad-users-or-groups - Lists AD users or groups information.

  • GET /external/v4/ad-users-or-groups/{id} - Get information related to AD User or Group

  • GET /external/v4/capacity-providers - Lists capacity providers.

  • GET /external/v4/capacity-providers/{id} - Retrieves a capacity provider.

  • POST /external/v1/ad-domains/{id}/action/add-auxiliary-accounts - Add auxiliary accounts to the untrusted domain

  • POST /external/v1/ad-domains/{id}/action/delete-auxiliary-accounts - Specification to delete auxiliary accounts from the untrusted domain

  • POST /external/v1/ad-domains/{id}/action/unbind - Unbind untrusted domain from the connection server.

  • POST /external/v1/ad-domains/{id}/action/update - Updates untrusted domain.

  • POST /external/v1/ad-domains/action/bind - Bind untrusted domain to the connection server.

  • POST /external/v1/ad-domains/action/update-auxiliary-accounts - Update auxiliary accounts of the untrusted domain

  • POST /external/v1/ad-users-or-groups/action/change-user-password - Changes the password of AD User

  • POST /external/v1/ad-users-or-groups/action/hold - Put users on hold.

  • POST /external/v1/ad-users-or-groups/action/release-hold - Release users from hold.

  • POST /external/v1/ad-users-or-groups/action/validate-user-encrypted-credentials - Validates the encrypted credentials of AD User

  • POST /external/v1/capacity-providers - Adds a capacity provider

  • POST /external/v1/datastores/action/compute-requirements - Computes the datastore space requirements for inventory resources.

  • POST /external/v1/datastores/action/compute-vsan-cost - Computes the vsan cost for given pool type.

  • POST /external/v2/ad-users-or-groups/action/hold - Put users on hold.

  • POST /external/v2/ad-users-or-groups/action/release-hold - Release users from hold.

  • POST /external/v2/capacity-providers - Adds a capacity provider

  • POST /external/v2/datastores/action/compute-requirements - Computes the datastore space requirements for inventory resources.

  • POST /external/v3/capacity-providers - Adds a capacity provider.

  • POST /external/v3/capacity-providers/action/validate-certificate - Validates the certificate for the capacity provider.

  • POST /external/v4/capacity-providers - Adds a capacity provider.

  • PUT /external/v2/capacity-providers/{id} - Updates a capacity provider

  • PUT /external/v3/capacity-providers/{id} - Updates a capacity provider.

  • PUT /external/v4/capacity-providers/{id} - Updates a capacity provider.


Federation Endpoints


  • DELETE /federation/v1/home-sites - Deletes the given home sites from the pod federation.

  • DELETE /federation/v1/sites/{id} - Deletes a site.

  • DELETE /federation/v2/home-sites - Deletes the given home sites from the pod federation.

  • DELETE /federation/v2/sites/{id} - Deletes a site.

  • DELETE /federation/v3/sites/{id} - Deletes a site.

  • GET /federation/v1/cpa - Retrieves the pod federation details.

  • GET /federation/v1/cpa/tasks - Lists all the CPA tasks in the pod federation.

  • GET /federation/v1/cpa/tasks/{id} - Retrieves the information for a given task.

  • GET /federation/v1/home-sites - Lists all the home sites in the pod federation.

  • GET /federation/v1/home-sites/{id} - Retrieves a given home site in the pod federation.

  • GET /federation/v1/pod-assignments - Lists all the pod assignments in the pod federation.

  • GET /federation/v1/pod-assignments/{id} - Retrieves a given pod assignment from the pod federation.

  • GET /federation/v1/pods - Lists all the pods in the pod federation.

  • GET /federation/v1/pods/{id} - Retrieves a given pod from the pod federation.

  • GET /federation/v1/pods/{id}/endpoints - Lists all the pod endpoints for the given pod.

  • GET /federation/v1/pods/{id}/endpoints/{endpointId} - Retrieves pod endpoint details for the given pod endpoint id in the given pod.

  • GET /federation/v1/sites - Lists all the sites in the pod federation.

  • GET /federation/v1/sites/{id} - Retrives a given site.

  • GET /federation/v2/cpa - Retrieves the pod federation details.

  • GET /federation/v2/home-sites - Lists all the home sites in the pod federation.

  • GET /federation/v2/home-sites/{id} - Retrieves a given home site in the pod federation.

  • GET /federation/v2/sites - Lists all the sites in the pod federation.

  • GET /federation/v2/sites/{id} - Retrives a given site.

  • GET /federation/v3/sites - Lists all the sites in the pod federation.

  • GET /federation/v3/sites/{id} - Retrieves a given site.

  • POST /federation/v1/cpa/action/eject - Removes a pod from Cloud Pod Federation.

  • POST /federation/v1/cpa/action/initialize - Initialize Cloud Pod Federation.

  • POST /federation/v1/cpa/action/join - Join Cloud Pod Federation.

  • POST /federation/v1/cpa/action/rotate-keypair - Request for an on demand CPA Key Pair rotation.

  • POST /federation/v1/cpa/action/uninitialize - Uninitialize Cloud Pod Federation.

  • POST /federation/v1/cpa/action/unjoin - Unjoin from Cloud Pod Federation.

  • POST /federation/v1/home-sites - Creates the given home sites in the pod federation.

  • POST /federation/v1/home-sites/action/resolve - Resolves home sites for a user in the pod federation.

  • POST /federation/v1/sites - Creates a site.

  • POST /federation/v2/home-sites - Creates the given home sites in the pod federation.

  • POST /federation/v2/home-sites/action/resolve - Resolves home sites for a user in the pod federation.

  • POST /federation/v2/sites - Creates a site.

  • POST /federation/v3/sites - Creates a site.

  • PUT /federation/v1/cpa - Updates a Pod Federation.

  • PUT /federation/v1/pods/{id} - Updates the given pod in the pod federation.

  • PUT /federation/v1/sites/{id} - Updates a site.

  • PUT /federation/v2/cpa - Updates a Pod Federation.

  • PUT /federation/v2/home-sites/{id} - Updates the given home sites from the pod federation.

  • PUT /federation/v2/sites/{id} - Updates a site.

  • PUT /federation/v3/sites/{id} - Updates a site.


Entitlements Endpoints


  • DELETE /entitlements/v1/application-pools - Delete the bulk entitlements for a set of application pools

  • DELETE /entitlements/v1/cloud-entitlements - Deletes cloud entitlements.

  • DELETE /entitlements/v1/desktop-pools - Delete the bulk entitlements for a set of desktop pools

  • DELETE /entitlements/v1/global-application-entitlements - Delete the bulk entitlements for a set of Global Application Entitlements

  • DELETE /entitlements/v1/global-desktop-entitlements - Delete the bulk entitlements for a set of Global Desktop Entitlements

  • GET /entitlements/v1/application-pools - Lists the entitlements for Application Pools in the environment.

  • GET /entitlements/v1/application-pools/{id} - Returns the IDs of users or groups entitled to a given application pool.

  • GET /entitlements/v1/cloud-entitlements - Lists cloud entitlements.

  • GET /entitlements/v1/desktop-pools - Lists the entitlements for Desktop Pools in the environment.

  • GET /entitlements/v1/desktop-pools/{id} - Returns the IDs of users or groups entitled to a given desktop pool.

  • GET /entitlements/v1/global-application-entitlements - Lists the user or group entitlements for Global Application Entitlements in the environment.

  • GET /entitlements/v1/global-application-entitlements/{id} - Gets the user or group entitlements for a Global Application Entitlement.

  • GET /entitlements/v1/global-desktop-entitlements - Lists the user or group entitlements for Global Desktop Entitlements in the environment.

  • GET /entitlements/v1/global-desktop-entitlements/{id} - Gets the user or group entitlements for a Global Desktop Entitlement.

  • POST /entitlements/v1/application-pools - Create the bulk entitlements for a set of application pools

  • POST /entitlements/v1/cloud-entitlements - Adds cloud entitlements.

  • POST /entitlements/v1/desktop-pools - Create the bulk entitlements for a set of desktop pools

  • POST /entitlements/v1/global-application-entitlements - Create the bulk entitlements for a set of Global Application Entitlements

  • POST /entitlements/v1/global-desktop-entitlements - Create the bulk entitlements for a set of Global Desktop Entitlements

  • PUT /entitlements/v1/desktop-pools - Updates the bulk entitlements for a set of desktop pools


Help Desk Endpoints


  • GET /helpdesk/v1/client - Retrieves Client Display Topology Information.

  • GET /helpdesk/v1/logon-timing/logon-segment - Retrieves the session timing data.

  • GET /helpdesk/v1/performance/display-protocol - Retrieves performance data of the current session display protocol (PCoIP or BLAST).

  • GET /helpdesk/v1/performance/historical-data - Retrieves historical performance data for the specific session in latest 15 minutes.

  • GET /helpdesk/v1/performance/process - Retrieves the process information.

  • GET /helpdesk/v1/performance/remote-application - Retrieves the remote applications information.

  • GET /helpdesk/v1/performance/remote-application/s4b-pairing-mode - Retrieves the remote applications s4b pairing mode information.

  • GET /helpdesk/v1/remote-assistant-ticket - Get a Microsoft Remote Assistance ticket by session Id.

  • GET /helpdesk/v1/ws1-assist - Retrieves ws1 assist agent status code.

  • GET /helpdesk/v2/logon-timing/logon-segment - Retrieves the session timing data.

  • GET /helpdesk/v2/performance/display-protocol - Retrieves performance data of the current session display protocol (PCoIP or BLAST).

  • GET /helpdesk/v2/performance/historical-data - Retrieves historical performance data for the specific session in latest 15 minutes.

  • GET /helpdesk/v2/performance/process - Retrieves the process information.

  • GET /helpdesk/v2/performance/remote-application - Retrieves the remote applications information.

  • GET /helpdesk/v2/remote-assistant-ticket - Get a Microsoft Remote Assistance ticket by session Id.

  • GET /helpdesk/v3/logon-timing/logon-segment - Retrieves the session timing data.

  • GET /helpdesk/v3/performance/display-protocol - Retrieves performance data of the current session display protocol (PCoIP or BLAST).

  • POST /helpdesk/v1/performance/remote-application/action/end-remote-application - Terminate an application running on virtual machine by session Id and the application Id.

  • POST /helpdesk/v1/performance/remote-process/action/end-remote-process - Terminate a process running on virtual machine by session Id and the basic process information.

  • POST /helpdesk/v1/ws1-assist - Initiates ws1 assist operation.


Login Endpoints


  • GET /login - Logs in a user with smart card. Returns access and refresh tokens.

  • POST /login - Logs in a user. Returns access token and refresh token.


Key Agreement Endpoints


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


Logout Endpoints


  • POST /logout - Logs out a user.


Session Refresh Endpoints


  • POST /refresh - Refreshes access token from refresh token.


What This Could Mean


  • For automation teams, the 2603 contract is broad enough to cover inventory discovery, pool and farm actions, entitlements, monitoring, authentication configuration, True SSO, UEM integration, and virtual center configuration from one REST surface.


  • For upgrade planning, the removed 2512 installer and precheck-style endpoints are worth reviewing if you built against early Connection Server lifecycle workflows.


  • For operational reporting, the monitor, helpdesk, inventory, and federation areas can reduce the need for screen scraping or manual console checks when building dashboards and runbooks.


  • For governance, keep generated clients pinned to a known Horizon Server API version and rerun contract checks before moving automation to a newer Horizon release.


Crawl Notes


  • Crawl date: May 7, 2026


  • Review window for highly recent changes: April 30-May 7, 2026


  • Scope: public Omnissa Developer Portal pages, embedded Swagger UI, direct JSON/OpenAPI assets, and the mapped public GitHub source file for Horizon Server APIs.


  • Endpoint descriptions are derived from the public Swagger summary/description fields where present, with simple wording used only when the spec does not publish a clean description.


Comments


bottom of page