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 Enterprise Task API

Start and stop tasks including reload and external program tasks

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

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

This API exposes 4 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2025.11.0.

Requests are made against a single base URL, https://{server}/api/about/v1.

4 operations 4 paths 1 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2025.11.0
Server
https://{server}/api/about/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Qlik Sense Enterprise Task API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Qlik-Xrfkey (xrfkey). By default, every request must be authenticated.

  • xrfkey — Cross-site request forgery prevention key. Must be 16 arbitrary characters and must match the Xrfkey query parameter.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Task 4

Start and stop tasks including reload and external program tasks

POST
/task/{id}/start
Qlik Sense Enterprise Start task
startTask 2 params → 204404401
POST
/task/{id}/start/synchronous
Qlik Sense Enterprise Start task synchronously
startTaskSync 2 params → 204404401
POST
/task/start/many
Qlik Sense Enterprise Start multiple tasks
startManyTasks 1 param body → 204401
POST
/task/{id}/stop
Qlik Sense Enterprise Stop task
stopTask 2 params → 204404401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (1 property). Each schema is shown below with its type and property counts.

Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qlik-sense-enterprise-task-api-openapi.yml Raw ↑

Other APIs Qlik Sense Enterprise publishes across the network.

Qlik Sense Engine JSON API
Qlik Sense Capabilities
Qlik Sense Enterprise About API
Qlik Sense Enterprise Access Type API
Qlik Sense Enterprise App API
Qlik Sense Enterprise App Object API
Qlik Sense Enterprise Components API
Qlik Sense Enterprise Content Library API
Qlik Sense Enterprise Custom Property API
Qlik Sense Enterprise Data Connection API
Qlik Sense Enterprise Extension API
Qlik Sense Enterprise External URLs API