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 Virtual Proxy API

Manage virtual proxy configurations

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

This API exposes 4 operations across 2 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.

4 operations 2 paths 4 schemas 2 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 Virtual Proxy 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 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Virtual Proxy 4

Manage virtual proxy configurations

GET
/virtualproxyconfig
Qlik Sense Enterprise List virtual proxy configurations
getVirtualProxyConfigs 3 params → 200401
POST
/virtualproxyconfig
Qlik Sense Enterprise Create virtual proxy configuration
createVirtualProxyConfig 1 param body → 201400401
GET
/virtualproxyconfig/{id}
Qlik Sense Enterprise Get virtual proxy configuration by ID
getVirtualProxyConfig 2 params → 200404401
PUT
/virtualproxyconfig/{id}
Qlik Sense Enterprise Update virtual proxy configuration
updateVirtualProxyConfig 2 params body → 200404401

Schemas 4

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

TagCondensed
object
3 properties
VirtualProxyConfigCondensed
object
4 properties
VirtualProxyConfig
object
26 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qlik-sense-enterprise-virtual-proxy-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