openapi: 3.1.0
info:
  title: Qlik Sense Enterprise Qlik Sense Service About External URLs 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: External URLs
  description: Retrieve configured external URL information
paths:
  /externalurls:
    get:
      operationId: getExternalUrls
      summary: Qlik Sense Enterprise Get external URLs
      description: Retrieves the external URL configuration for the Qlik Sense site, including the hub URI, QMC URI, and API endpoint URIs that are accessible from outside the deployment.
      tags:
      - External URLs
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: External URLs returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalUrls'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ExternalUrls:
      type: object
      properties:
        hubUri:
          type: string
          format: uri
          description: External URL to access the Qlik Sense Hub
        qmcUri:
          type: string
          format: uri
          description: External URL to access the Qlik Management Console
        apiUri:
          type: string
          format: uri
          description: External URL for API access
        resultUri:
          type: string
          format: uri
          description: External URL for result access
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
  responses:
    Unauthorized:
      description: Authentication failed or Xrfkey missing/mismatched.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    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.