Qlik Sense Enterprise Qlik Sense About Service API

naftiko: 1.0.0-alpha2
info:
  label: Qlik Sense Enterprise Qlik Sense About Service 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.
  tags:
  - Qlik
  - Sense
  - Enterprise
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: qlik-sense-enterprise
    baseUri: https://localhost/api/about/v1
    description: Qlik Sense Enterprise Qlik Sense About Service API HTTP API.
    authentication:
      type: apikey
      in: header
      name: X-Qlik-Xrfkey
      value: '{{QLIK_SENSE_ENTERPRISE_TOKEN}}'
    resources:
    - name: systeminfo
      path: /systeminfo
      operations:
      - name: getsysteminfo
        method: GET
        description: Qlik Sense Enterprise Get system information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: components
      path: /components
      operations:
      - name: getcomponents
        method: GET
        description: Qlik Sense Enterprise Get installed components
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: externalurls
      path: /externalurls
      operations:
      - name: getexternalurls
        method: GET
        description: Qlik Sense Enterprise Get external URLs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: thirdparty
      path: /thirdparty
      operations:
      - name: getthirdpartyinfo
        method: GET
        description: Qlik Sense Enterprise Get third-party software information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: qlik-sense-enterprise-rest
    description: REST adapter for Qlik Sense Enterprise Qlik Sense About Service API.
    resources:
    - path: /systeminfo
      name: getsysteminfo
      operations:
      - method: GET
        name: getsysteminfo
        description: Qlik Sense Enterprise Get system information
        call: qlik-sense-enterprise.getsysteminfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /components
      name: getcomponents
      operations:
      - method: GET
        name: getcomponents
        description: Qlik Sense Enterprise Get installed components
        call: qlik-sense-enterprise.getcomponents
        outputParameters:
        - type: object
          mapping: $.
    - path: /externalurls
      name: getexternalurls
      operations:
      - method: GET
        name: getexternalurls
        description: Qlik Sense Enterprise Get external URLs
        call: qlik-sense-enterprise.getexternalurls
        outputParameters:
        - type: object
          mapping: $.
    - path: /thirdparty
      name: getthirdpartyinfo
      operations:
      - method: GET
        name: getthirdpartyinfo
        description: Qlik Sense Enterprise Get third-party software information
        call: qlik-sense-enterprise.getthirdpartyinfo
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: qlik-sense-enterprise-mcp
    transport: http
    description: MCP adapter for Qlik Sense Enterprise Qlik Sense About Service API for AI agent use.
    tools:
    - name: getsysteminfo
      description: Qlik Sense Enterprise Get system information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qlik-sense-enterprise.getsysteminfo
      outputParameters:
      - type: object
        mapping: $.
    - name: getcomponents
      description: Qlik Sense Enterprise Get installed components
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qlik-sense-enterprise.getcomponents
      outputParameters:
      - type: object
        mapping: $.
    - name: getexternalurls
      description: Qlik Sense Enterprise Get external URLs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qlik-sense-enterprise.getexternalurls
      outputParameters:
      - type: object
        mapping: $.
    - name: getthirdpartyinfo
      description: Qlik Sense Enterprise Get third-party software information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qlik-sense-enterprise.getthirdpartyinfo
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    QLIK_SENSE_ENTERPRISE_TOKEN: QLIK_SENSE_ENTERPRISE_TOKEN