openapi: 3.1.0
info:
  title: Qlik Sense Enterprise Qlik Sense Service About Health 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: Health
  description: Health check and service status endpoints
paths:
  /health:
    get:
      operationId: getProxyHealth
      summary: Qlik Sense Enterprise Check proxy service health
      description: Returns the health status of the Qlik Sense Proxy Service.
      tags:
      - Health
      responses:
        '200':
          description: Proxy service is healthy
        '503':
          description: Proxy service is unhealthy
components:
  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.