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

Manage navigation links that connect selection apps to template apps for on-demand app generation

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

This API exposes 5 operations across 2 paths, and defines 6 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.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 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 Links 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 5

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

Links 5

Manage navigation links that connect selection apps to template apps for on-demand app generation

GET
/links
Qlik Sense Enterprise List navigation links
getOdagLinks 1 param → 200401
POST
/links
Qlik Sense Enterprise Create navigation link
createOdagLink 1 param body → 201400401
GET
/links/{linkId}
Qlik Sense Enterprise Get navigation link by ID
getOdagLink 2 params → 200404401
PUT
/links/{linkId}
Qlik Sense Enterprise Update navigation link
updateOdagLink 2 params body → 200404401
DELETE
/links/{linkId}
Qlik Sense Enterprise Delete navigation link
deleteOdagLink 2 params → 204404401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are OdagLink (9 properties), OdagLinkProperties (5 properties), OdagLinkCreate (4 properties), OdagBinding (3 properties). Each schema is shown below with its type and property counts.

OdagLinkCreate
object
4 properties 3 required
OdagLinkUpdate
object
2 properties
OdagLinkProperties
object
5 properties
OdagLink
object
9 properties
OdagBinding
object
3 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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