Qlik Sense Enterprise Virtual Proxy API

openapi: 3.1.0
info:
  title: Qlik Sense Enterprise Qlik Sense Service About Virtual Proxy API
  description: REST API for retrieving product information about a Qlik Sense site, including system details, installed components, external URLs, and third-party software information. The About Service API provides read-only endpoints that return JSON-formatted information about the Qlik Sense 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-about-service
servers:
- url: https://{server}/api/about/v1
  description: About Service API via HTTPS
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
security:
- xrfkey: []
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:
  responses:
    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'
    NotFound:
      description: The requested entity was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    TagCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
    VirtualProxyConfigCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        prefix:
          type: string
        description:
          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
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
  parameters:
    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
    IdParam:
      name: id
      in: path
      required: true
      description: Unique identifier (GUID) of the entity
      schema:
        type: string
        format: uuid
    PrivilegesParam:
      name: privileges
      in: query
      required: false
      description: Whether to append privilege information to the returned entities.
      schema:
        type: boolean
        default: false
    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
  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.