Advance Deprecation Announcement for Horizon View API and Replacement with REST API (6000139)
Details
- This KB article covers the future deprecation of the Horizon View APIs in Q4 Release of 2025 and its removal in upcoming future releases. Our deprecation of View APIs will be handled as follows:
- Horizon Q4 2025 Release will be the last version to include the SOAP-based Horizon View APIs. The newer releases after Q4 2025 will only contain the Horizon REST APIs.
- However, View API will continue to be supported through the lifetime of Horizon versions prior to, and including, Horizon Q4 2025 Release until End-of-General Support (EOGS). See Product Lifecycle Matrix for Horizon EOGS.
- If you upgrade your Horizon version that was running successfully with View APIs to a newer release of Horizon, i.e. beyond Horizon Q4 2025 Release, it is possible the API use-cases will no longer function with that new release. Generally, Omnissa will not provide any fix or workaround for such issues besides either switching to Horizon REST APIs or downgrading back to the old release.
- With the deprecation of View APIs, we will also be removing the support for Horizon PowerCLI module, which itself is based upon the View APIs.
Solution
Starting with Horizon 2312 ESB Release, we have the RESTful version of all the View APIs that you can use for day-two operations and automation and achieved parity with existing View APIs. As a next step, we plan to sunset the existing View APIs, and we are announcing this early to give customers and partners a chance to plan.
REST API provides several advantages over the View API, which is based on SOAP. REST API in general have better programmability, greater scalability and higher performance compared to SOAP-based API.
As time goes on, Omnissa Horizon will add more features that function only with REST, not View APIs.
Impact:
For the customers and partners using View APIs, there are no immediate changes as this is an advance notice. However, customers are advised to start considering migrating the API use-cases they may have in their environment to the REST APIs.
- All the View APIs continue to work as it is for now.
- Customers and partners are advised to start migrating to the Horizon REST APIs.
- If you are working directly with View APIs, then you can start working on the migration to the REST APIs.
- If you are using PowerCLI scripts, we recommend using REST APIs directly to automate your Horizon environment.
Future considerations for Horizon support of View API:
In a future release of Horizon, Omnissa will completely remove support for View API, and hence strongly recommends that customers start evaluating using REST API as default in their environment.
Related Information:
Please refer to the Horizon Server API Documentation for documentation on Horizon REST APIs.