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 Requests API

Manage on-demand app generation requests including submission, status tracking, and app lifecycle operations

Qlik Sense Enterprise Requests 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 Requests. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 8 operations across 6 paths, and defines 4 schemas. 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.

8 operations 6 paths 4 schemas 1 DELETE3 GET3 POST1 PUT

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 Requests 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 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Requests 8

Manage on-demand app generation requests including submission, status tracking, and app lifecycle operations

GET
/links/{linkId}/requests
Qlik Sense Enterprise List requests for a navigation link
getOdagLinkRequests 2 params → 200404401
POST
/links/{linkId}/requests
Qlik Sense Enterprise Submit app generation request
submitOdagRequest 2 params body → 201400404401
GET
/requests
Qlik Sense Enterprise List all ODAG requests
getOdagRequests 1 param → 200401
GET
/requests/{requestId}
Qlik Sense Enterprise Get ODAG request by ID
getOdagRequest 2 params → 200404401
PUT
/requests/{requestId}
Qlik Sense Enterprise Update ODAG request
updateOdagRequest 2 params body → 200404401
DELETE
/requests/{requestId}/app
Qlik Sense Enterprise Remove generated app from request
deleteOdagRequestApp 2 params → 204404401
POST
/requests/{requestId}/reloadApp
Qlik Sense Enterprise Reload generated app
reloadOdagRequestApp 2 params → 200404401
POST
/requests/{requestId}/renameApp
Qlik Sense Enterprise Rename generated app
renameOdagRequestApp 2 params body → 200404401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are OdagRequest (12 properties), Error (1 property), OdagRequestCreate (1 property), OdagRequestUpdate (1 property). Each schema is shown below with its type and property counts.

OdagRequestUpdate
object
1 property
OdagRequest
object
12 properties
OdagRequestCreate
object
1 property 1 required
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qlik-sense-enterprise-requests-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