find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/qlik-sense-enterprise-about-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Qlik Sense Enterprise About API
  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-refined-note:
  - x-serviceName differs across the merged source definitions and was not carried
  - x-stabilityIndex differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged About across 3 of this provider''s published API definitions: qlik-sense-enterprise-odag-service-openapi.yml, qlik-sense-enterprise-proxy-service-openapi.yml, qlik-sense-enterprise-repository-service-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{server}/api/odag/v1
  description: ODAG Service API endpoint
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
- url: https://{server}:4243/qps
  description: Backend QPS API for services to query and modify proxy state (port 4243)
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
- url: https://{server}/{virtualProxy}/qps
  description: Frontend QPS API accessed via a virtual proxy access point (port 443)
  variables:
    server:
      default: localhost
      description: Qlik Sense server hostname
    virtualProxy:
      default: ''
      description: Virtual proxy prefix
- 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
tags:
- name: About
  description: ODAG service metadata
paths:
  /about:
    get:
      operationId: getOdagAbout
      summary: Qlik Sense Enterprise Get ODAG service information
      description: Retrieves basic information about the ODAG service including its version and stability index.
      tags:
      - About
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      responses:
        '200':
          description: ODAG service information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OdagAbout'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
      - xrfkey: []
    servers:
    - url: https://{server}/api/odag/v1
      description: ODAG Service API endpoint
      variables:
        server:
          default: localhost
          description: Qlik Sense server hostname
  /about/description:
    get:
      operationId: getProxyApiDescription
      summary: Qlik Sense Enterprise Get complete endpoint description
      description: Retrieves a complete list of all endpoints available in the QPS API. This serves as the API discovery mechanism.
      tags:
      - About
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam_2'
      responses:
        '200':
          description: API endpoint descriptions returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EndpointDescription'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      security:
      - xrfkey: []
      - certificate: []
    servers:
    - url: https://{server}:4243/qps
      description: Backend QPS API for services to query and modify proxy state (port 4243)
      variables:
        server:
          default: localhost
          description: Qlik Sense server hostname
    - url: https://{server}/{virtualProxy}/qps
      description: Frontend QPS API accessed via a virtual proxy access point (port 443)
      variables:
        server:
          default: localhost
          description: Qlik Sense server hostname
        virtualProxy:
          default: ''
          description: Virtual proxy prefix
  /about/api/description:
    get:
      operationId: getApiDescription
      summary: Qlik Sense Enterprise Get API endpoint descriptions
      description: Retrieves a description of all available QRS API endpoints, optionally filtered by HTTP method and in an extended format.
      tags:
      - About
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam_3'
      - name: extended
        in: query
        description: Whether to return extended descriptions
        schema:
          type: boolean
          default: false
      - name: method
        in: query
        description: Filter endpoints by HTTP method
        schema:
          type: string
          enum:
          - GET
          - POST
          - PUT
          - DELETE
      - name: format
        in: query
        description: Response format
        schema:
          type: string
          enum:
          - JSON
      responses:
        '200':
          description: API description returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EndpointDescription_2'
        '401':
          $ref: '#/components/responses/Unauthorized_3'
      security:
      - xrfkey: []
      - certificate: []
      - windowsAuth: []
    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
  /about/api/default:
    get:
      operationId: getApiDefaults
      summary: Qlik Sense Enterprise Get default values for all entity types
      description: Retrieves the default values for all entity types in the QRS, optionally including list entries.
      tags:
      - About
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam_3'
      - name: listentries
        in: query
        description: Whether to include list entries in the defaults
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Default entity values returned successfully
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized_3'
      security:
      - xrfkey: []
      - certificate: []
      - windowsAuth: []
    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
  /about/api/enums:
    get:
      operationId: getApiEnums
      summary: Qlik Sense Enterprise Get enumeration types
      description: Retrieves all enumeration types used across the QRS API, including their allowed values.
      tags:
      - About
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam_3'
      responses:
        '200':
          description: Enumeration types returned successfully
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized_3'
      security:
      - xrfkey: []
      - certificate: []
      - windowsAuth: []
    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
  /cache:
    delete:
      operationId: invalidateCache
      summary: Qlik Sense Enterprise Invalidate cache
      description: Invalidates the QRS cache, forcing fresh data retrieval on subsequent requests. Use with caution as this impacts performance.
      tags:
      - About
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam_3'
      responses:
        '204':
          description: Cache invalidated successfully
        '401':
          $ref: '#/components/responses/Unauthorized_3'
      security:
      - xrfkey: []
      - certificate: []
      - windowsAuth: []
    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
components:
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
    OdagAbout:
      type: object
      properties:
        version:
          type: string
          description: ODAG service version
        stabilityIndex:
          type: string
          description: API stability level (e.g., stable)
    EndpointDescription:
      type: object
      properties:
        method:
          type: string
          description: HTTP method
        path:
          type: string
          description: Endpoint path
        description:
          type: string
          description: Endpoint description
    ProxyAbout:
      type: object
      properties:
        buildVersion:
          type: string
          description: QPS build version
        buildDate:
          type: string
          description: QPS build date
    AboutInfo:
      type: object
      properties:
        buildVersion:
          type: string
          description: QRS API build version
        buildDate:
          type: string
          description: QRS API build date
        databaseProvider:
          type: string
          description: Database provider used by the repository
        nodeType:
          type: integer
          description: Type of the node (0=Central, 1=Non-central)
        sharedPersistence:
          type: boolean
          description: Whether shared persistence is configured
        requiresBootstrap:
          type: boolean
          description: Whether the node requires bootstrapping
    EndpointDescription_2:
      type: object
      properties:
        method:
          type: string
          description: HTTP method
        path:
          type: string
          description: Endpoint path
        description:
          type: string
          description: Endpoint description
        parameters:
          type: array
          items:
            type: object
  parameters:
    XrfKeyParam:
      name: Xrfkey
      in: query
      required: true
      description: Cross-site request forgery prevention key matching the X-Qlik-Xrfkey header.
      schema:
        type: string
        minLength: 16
        maxLength: 16
    XrfKeyParam_2:
      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
    XrfKeyParam_3:
      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
  responses:
    Unauthorized:
      description: Authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized_2:
      description: Authentication failed or Xrfkey missing/mismatched.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized_3:
      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'
  securitySchemes:
    xrfkey:
      type: apiKey
      in: header
      name: X-Qlik-Xrfkey
      description: Cross-site request forgery prevention key. Must be 16 arbitrary characters.
    certificate:
      type: mutualTLS
      description: Client certificate authentication using certificates exported from Qlik Sense.
    windowsAuth:
      type: http
      scheme: negotiate
      description: Windows Integrated Authentication (NTLM/Kerberos) used when connecting via the Qlik Sense Proxy Service.
x-refined-from:
- qlik-sense-enterprise-odag-service-openapi.yml
- qlik-sense-enterprise-proxy-service-openapi.yml
- qlik-sense-enterprise-repository-service-openapi.yml