API comparison between products

Whether you're building solutions for Qlik Sense client managed (Windows) or Qlik Cloud, many of the APIs are cross-compatible and work with either deployment. However, there are some subtle differences, or unavailable methods in the cloud you want to know about.

The list below indicates if the API is compatible with client managed editions of Qlik Sense, compatible on Qlik Cloud, and if there are any differences to expect.

In general, almost all of the APIs related to embedding visualizations are compatible across products with minor modifications to authentication and cross-site origin handling. For specific client-managed APIs like the Repository Service API and the Proxy API, refer to the known differences to understand the way these APIs are represented in Qlik Cloud.

APIClient-managed CompatibleCloud CompatibleKnown Differences
App Integration APIYESYES
Single APIYESYES
Visualization APIYESYES
Repository APIYESNOOn Qlik Cloud, management APIs are separated into their own resources. Learn more here.
Engine JSON APIYESYESExportData method disabled in Cloud, replaced by Reporting Services API
Extension APIYESYES
Backend APIYESYESRefer to the client-managed documentation for using the Backend API with Qlik Cloud
qlik-cliYESYESThe qlik-cli for Qlik Cloud does have support for many Client-managed Repository service API endpoints. However, if you require the full compliment of REST endpoints available for Client-managed editions of Qlik Sense, please follow the Client managed link.
.NET SDKYESYESRefer to the client-managed documentation for using the .NET SDK with Qlik Cloud

Capability APIs

APIClient-managed CompatibleCloud CompatibleKnown Differences
Root APIYESYESRefer to the client-managed documentation for using the Root API with Qlik Cloud
  • callRepository method (deprecated)
  • getAppList method is replaced by the items API in Qlik Cloud using the resource type query string parameter equal to app
  • getExtensionList method is replaced by the Extensions REST API in Qlik Cloud. Returns a list for the tenant, not the app.
  • getGlobal method is not available in Qlik Cloud. Engine connections in cloud require a Qlik Sense application.
  • sessionApp method is not available in Qlik Cloud through Root API. Use enigma.js instead.
  • sessionAppFromApp method is not available in Qlik Cloud through Root API. Use enigma.js instead.
App APIYESYES
Field APIYESYES
Global APIYESNO
Navigation APIYESYES
Selection APIYESYES
Table APIYESYES
Theme APIYESYES
Variable APIYESYES
Visualization APIYESYES

Libraries and Tools

APIClient-managed CompatibleCloud CompatibleKnown Differences
qlik-cliYESYESThe qlik-cli for Qlik Cloud does have support for many Client-managed Repository service API endpoints. However, if you require the full compliment of REST endpoints available for Client-managed editions of Qlik Sense, please follow the Client managed link.
.NET SDKYESYESRefer to the client-managed documentation for using the .NET SDK with Qlik Cloud
enigma.jsYESYES
enigma-goYESYES
nebula.jsYESYES
picasso.jsYESYES
leonardo-uiYESYES

Client-managed specific

APIClient-managed CompatibleCloud CompatibleKnown Differences
QVX SDKYESNO
Repository APIYESNOOn Qlik Cloud, management APIs are separated into their own resources. Learn more here.
Proxy APIYESNORefer to the identity providers API for configuring authentication options in Qlik Cloud. Refer to JWT authorization to integrate authorization to Qlik Cloud into your applications.
Personal APIYESNO
ODAG Service APIYESNO
Natural Language Query APIYESNO
User Directory Connector APIYESNO
About Service APIYESNO
Was this page helpful?