Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Sense Apps API

Manage Qlik Sense analytics applications including creating, copying, importing, exporting, publishing, and retrieving app metadata.

Qlik Sense Apps API is one of 8 APIs that Qlik Sense publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Apps. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 19 operations across 13 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com/api/v1.

19 operations 13 paths 10 schemas 2 DELETE7 GET6 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://{tenant}.{region}.qlikcloud.com/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qlik Sense Apps API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 bearer token obtained from the Qlik Cloud tenant. Use the /oauth/token endpoint or interactive login to obtain a token.
  • apiKey — API key generated from the Qlik Cloud Management Console. Passed in the Authorization header as Bearer .

Paths & Operations 19

Across 13 paths, the API surfaces 19 operations — 2 DELETE, 7 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Apps 19

Manage Qlik Sense analytics applications including creating, copying, importing, exporting, publishing, and retrieving app metadata.

GET
/apps
Get app privileges
getAppsPrivileges → 200401
POST
/apps
Create an app
createApp body → 200400401403
GET
/apps/{appId}
Retrieve an app
getApp 1 param → 200401403404
PUT
/apps/{appId}
Update an app
updateApp 1 param body → 200400401403404
DELETE
/apps/{appId}
Delete an app
deleteApp 1 param → 200401403404
POST
/apps/{appId}/copy
Copy an app
copyApp 1 param body → 200401403404
POST
/apps/{appId}/export
Export an app
exportApp 1 param body → 200401403404
POST
/apps/import
Import an app
importApp 3 params body → 200400401403
POST
/apps/{appId}/publish
Publish an app
publishApp 1 param body → 200400401403404
PUT
/apps/{appId}/publish
Republish an app
republishApp 1 param body → 200400401403404
PUT
/apps/{appId}/owner
Change app owner
updateAppOwner 1 param body → 200401403404
PUT
/apps/{appId}/space
Move app to a space
moveAppToSpace 1 param body → 200401403404
DELETE
/apps/{appId}/space
Remove app from space
removeAppFromSpace 1 param → 200401403404
GET
/apps/{appId}/data/metadata
Retrieve data metadata for an app
getAppDataMetadata 1 param → 200401403404
GET
/apps/{appId}/data/lineage
Retrieve data lineage for an app
getAppDataLineage 1 param → 200401403404
GET
/apps/{appId}/scripts
Retrieve script history
getAppScripts 1 param → 200401403404
POST
/apps/{appId}/scripts
Set script for an app
setAppScript 1 param body → 200401403404
GET
/apps/{appId}/reloads/logs
Retrieve script log metadata
getAppReloadLogs 1 param → 200401403404
GET
/apps/{appId}/reloads/logs/{reloadId}
Retrieve a specific reload log
getAppReloadLog 2 params → 200401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AppAttributes (21 properties), AppScript (4 properties), ReloadLog (4 properties), AppCopy (3 properties). Each schema is shown below with its type and property counts.

AppScript
object
A script version for an app.
4 properties
ReloadLog
object
Metadata about an app reload log.
4 properties
AppDataMetadata
object
Data model and reload statistics metadata for an app.
3 properties
AppUpdate
object
Payload to update an existing app.
2 properties
ErrorResponse
object
Standard error response.
1 property
AppCreate
object
Payload to create a new app.
3 properties 1 required
AppAttributes
object
Represents a Qlik Sense analytics application.
21 properties
AppPublish
object
Payload to publish an app to a managed space.
3 properties 1 required
AppCopy
object
Payload to copy an app.
3 properties
AppDataLineage
object
Data lineage information for an app.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qlik-sense-apps-api-openapi.yml Raw ↑

Other APIs Qlik Sense publishes across the network.

Qlik Sense Engine API
Qlik Sense Repository API
Qlik Sense Proxy API
Qlik Data Integration API
Qlik Embedding API
Qlik Sense Reloads API
Qlik Sense Spaces API