StoreFront Web API

Last published : Oct 31, 2026
StoreFront provides a HTTP API which you can use to implement your own portal. It is suitable for consumption by JavaScript clients running in a web browser or by native applications developed using a wide variety of languages and frameworks.
The main operations available through this API include:
  • Authenticating users through a variety of methods: explicit forms, domain pass-through, smart card, NetScaler Gateway Single Sign-On, and post credentials.
  • Enumerating applications and desktops.
  • Enumerating available HDX sessions.
  • Reconnecting, disconnecting, and logging off HDX sessions.
  • Launching applications and desktops.
  • Powering off specific VDI desktops.
  • Retrieving images and icons for applications and desktops.
  • Subscribing to applications.
This API is useful for anyone who wants to write a new Web UI or integrate StoreFront into their own Web portal.
To get started with the API, see Getting started. For code samples, see Portal example and Open source samples.