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 Load Balancing API

Engine load balancing decisions for distributing app sessions across Qlik Sense Engine Services

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

This API exposes 1 operation across 1 path, 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.

1 operations 1 paths 4 schemas 1 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 Load Balancing 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 1

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

Load Balancing 1

Engine load balancing decisions for distributing app sessions across Qlik Sense Engine Services

POST
/loadbalancing/prioritize
Qlik Sense Enterprise Prioritize engine services for load balancing
prioritizeLoadBalancing 1 param body → 200400401

Schemas 4

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

LoadBalancingResult
object
1 property
EngineServicePriority
object
5 properties
LoadBalancingRequest
object
3 properties 3 required
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qlik-sense-enterprise-load-balancing-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