Qlik Sense Enterprise Virtual Proxy API

openapi: 3.2.0
info:
  title: Qlik Sense Enterprise Qlik Sense Repository Service Virtual…
  description: Core REST API for managing Qlik Sense Enterprise resources including apps, streams, users, security rules, and all configuration available through the Qlik Management Console (QMC). The QRS API provides CRUD operations for all entity types in the Qlik Sense repository, enabling programmatic administration of a Qlik Sense Enterprise deployment.
  version: 2025.11.0
  contact:
    name: Qlik Support
    url: https://community.qlik.com/
  license:
    name: Proprietary
    url: https://www.qlik.com/us/legal/terms-of-use
  x-providerName: Qlik
  x-serviceName: qlik-sense-repository-service
servers:
- url: https://{server}:4242/qrs
  description: Direct QRS connection via certificate authentication
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
- url: https://{server}/qrs
  description: QRS connection via Qlik Sense Proxy Service (QPS)
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
security:
- xrfkey: []
- certificate: []
- windowsAuth: []
tags:
- name: Virtual Proxy
  description: Manage virtual proxy configurations
paths:
  /virtualproxyconfig:
    get:
      operationId: getVirtualProxyConfigs
      summary: Qlik Sense Enterprise List virtual proxy configurations
      description: Retrieves a list of all virtual proxy configurations.
      tags:
      - Virtual Proxy
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Virtual proxy configurations returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VirtualProxyConfigCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createVirtualProxyConfig
      summary: Qlik Sense Enterprise Create virtual proxy configuration
      description: Creates a new virtual proxy configuration with authentication and session handling settings.
      tags:
      - Virtual Proxy
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualProxyConfig'
      responses:
        '201':
          description: Virtual proxy configuration created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualProxyConfig'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /virtualproxyconfig/{id}:
    get:
      operationId: getVirtualProxyConfig
      summary: Qlik Sense Enterprise Get virtual proxy configuration by ID
      description: Retrieves a single virtual proxy configuration by its unique identifier.
      tags:
      - Virtual Proxy
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Virtual proxy configuration returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualProxyConfig'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateVirtualProxyConfig
      summary: Qlik Sense Enterprise Update virtual proxy configuration
      description: Updates an existing virtual proxy configuration.
      tags:
      - Virtual Proxy
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualProxyConfig'
      responses:
        '200':
          description: Virtual proxy configuration updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualProxyConfig'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    TagCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
    VirtualProxyConfig:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        modifiedByUserName:
          type: string
        prefix:
          type: string
          description: Virtual proxy prefix used in URLs
        description:
          type: string
          description: Description of the virtual proxy
        authenticationModuleRedirectUri:
          type: string
          format: uri
          description: URI to redirect to for authentication
        sessionModuleBaseUri:
          type: string
          format: uri
          description: Base URI of the session module
        loadBalancingModuleBaseUri:
          type: string
          format: uri
          description: Base URI of the load balancing module
        authenticationMethod:
          type: integer
          description: Authentication method (0=Ticket, 1=HeaderStaticUserDirectory, 2=HeaderDynamicUserDirectory, 3=SAML, 4=JWT)
        headerAuthenticationMode:
          type: integer
          description: Header authentication mode
        headerAuthenticationHeaderName:
          type: string
          description: Name of the header used for header-based authentication
        headerAuthenticationStaticUserDirectory:
          type: string
        headerAuthenticationDynamicUserDirectory:
          type: string
        anonymousAccessMode:
          type: integer
          description: Anonymous access mode (0=None, 1=AnonymousAllowed)
        windowsAuthenticationEnabledDevicePattern:
          type: string
        sessionCookieHeaderName:
          type: string
          description: Name of the session cookie header
        sessionCookieDomain:
          type: string
        additionalResponseHeaders:
          type: string
        sessionInactivityTimeout:
          type: integer
          description: Session inactivity timeout in minutes
        extendedSecurityEnvironment:
          type: boolean
        websocketCrossOriginWhiteList:
          type: array
          items:
            type: string
        defaultVirtualProxy:
          type: boolean
          description: Whether this is the default virtual proxy
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
    VirtualProxyConfigCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        prefix:
          type: string
        description:
          type: string
        privileges:
          type: array
          items:
            type: string
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
  responses:
    NotFound:
      description: The requested entity was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication failed. The request lacks valid authentication credentials or the Xrfkey header/parameter is missing or mismatched.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request. The request body or parameters are malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    IdParam:
      name: id
      in: path
      required: true
      description: Unique identifier (GUID) of the entity
      schema:
        type: string
        format: uuid
    XrfKeyParam:
      name: Xrfkey
      in: query
      required: true
      description: Cross-site request forgery prevention key. Must be 16 arbitrary characters matching the X-Qlik-Xrfkey header value.
      schema:
        type: string
        minLength: 16
        maxLength: 16
    PrivilegesParam:
      name: privileges
      in: query
      required: false
      description: Whether to append privilege information to the returned entities.
      schema:
        type: boolean
        default: false
    FilterParam:
      name: filter
      in: query
      required: false
      description: 'Filter expression using the syntax: property operator value. Supports operators like eq, ne, so, ew, sw. Example: name eq ''MyApp'''
      schema:
        type: string
  securitySchemes:
    xrfkey:
      type: apiKey
      in: header
      name: X-Qlik-Xrfkey
      description: Cross-site request forgery prevention key. Must be 16 arbitrary characters and must match the Xrfkey query parameter.
    certificate:
      type: mutualTLS
      description: Client certificate authentication using certificates exported from Qlik Sense. Used when connecting directly to QRS on port 4242.
    windowsAuth:
      type: http
      scheme: negotiate
      description: Windows Integrated Authentication (NTLM/Kerberos) used when connecting via the Qlik Sense Proxy Service.