Skip to main content

API reference for Windows

The following API reference is for Qlik Sense Enterprise on Windows only.

If you are interested in SaaS editions of Qlik Sense APIs, see the API reference documentation in the Qlik Developer portal.

Information noteIf you plan on using capability APIs to build custom visualizations, mashups, or extensions, consider using the nebula.js open-source library available on NPM instead. nebula.js is a collection of JavaScript libraries, visualizations, and CLIs that helps developers build and integrate visualizations on top of Qlik's Associative Engine. For more information, see nebula.js.

Building mashups and custom visualization objects

Use these resources to build and bring capabilities into visualization extensions, and mashups.

API name API type Visualization extensions Mashups
Engine JSON API JSON RPC Yes Yes
Extension API JavaScript library Yes No
Backend API JavaScript library Yes No
Root API

JavaScript library (Capability API)

Yes Yes
App API

JavaScript library (Capability API)

Yes Yes
Bookmark API

JavaScript library (Capability API)

Yes Yes
Field API

JavaScript library (Capability API)

Yes Yes
Global API

JavaScript library (Capability API)

Yes Yes
Navigation API

JavaScript library (Capability API)

Yes No
Selection API

JavaScript library (Capability API)

Yes Yes
Table API

JavaScript library (Capability API)

Yes Yes
Theme API

JavaScript library (Capability API)

No Yes
Variable API

JavaScript library (Capability API)

Yes Yes
Visualization API

JavaScript library (Capability API)

No Yes
App Integration API URL integration No Yes
Single Integration API

URL integration

No Yes
qlik-visual Web component No Yes
enigma.js JavaScript library (Open Source) Yes Yes
enigma-go Go library (Open Source) Yes Yes
leonardo-ui UI library (Open Source) Yes Yes
picasso.js JavaScript library (Open Source) Yes Yes

 

Building connectors

Use the QVX SDK to build customized connectors, used to retrieve data from data sources not supported by a generic Qlik Sense installation.

QVX SDK

Building Windows applications

Use the .NET SDK to integrate Qlik Sense in your own Windows (.NET) applications.

.NET SDK

Managing and automating administrative jobs

Use the REST APIs to manage data, configuration information and authentication.

Proxy Service API

Repository Service API

Retrieving information about the product

Use the REST API to retrieve product information including details about the system, components, external URLs, and third-party software.

About Service API

Creating on-demand apps

Use the REST API to create on-demand apps by accessing the ODAG Service API.

ODAG Service API

Importing users and groups

Use the .NET API to import users and groups in Qlik Sense.

User Directory Connector API

Checking the health of Qlik services

The following API endpoints are available for service health checks. Use the HTTP GET method to call the API endpoint. If the service is running correctly, you should receive a 200 status code.

Service API endpoint
Qlik Repository https://{QSE_domain}/qrs/about
Qlik Proxy https://{QSE_domain}:4243/qps/alive
Qlik Engine

https://{QSE_domain}:4747/healthcheck (or https://{QSE_domain}/engine/healthcheck)

Qlik Scheduler

https://{QSE_domain}:5050/qss/alive (Use port 5151 for slave scheduler)

Qlik Printing

https://{QSE_domain/printing/alive