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

ODAG service metadata

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

This API exposes 6 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.

6 operations 6 paths 4 schemas 1 DELETE5 GET

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 About 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 6

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

About 6

ODAG service metadata

GET
/about
Qlik Sense Enterprise Get ODAG service information
getOdagAbout 1 param → 200401
GET
/about/description
Qlik Sense Enterprise Get complete endpoint description
getProxyApiDescription 1 param → 200401
GET
/about/api/description
Qlik Sense Enterprise Get API endpoint descriptions
getApiDescription 4 params → 200401
GET
/about/api/default
Qlik Sense Enterprise Get default values for all entity types
getApiDefaults 2 params → 200401
GET
/about/api/enums
Qlik Sense Enterprise Get enumeration types
getApiEnums 1 param → 200401
DELETE
/cache
Qlik Sense Enterprise Invalidate cache
invalidateCache 1 param → 204401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are EndpointDescription_2 (4 properties), EndpointDescription (3 properties), OdagAbout (2 properties), Error (1 property). Each schema is shown below with its type and property counts.

EndpointDescription_2
object
4 properties
EndpointDescription
object
3 properties
OdagAbout
object
2 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Qlik Sense Enterprise publishes across the network.

Qlik Sense Engine JSON API
Qlik Sense Capabilities
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
Qlik Sense Enterprise Health API