Qlik Sense Enterprise Content Library API

openapi: 3.2.0
info:
  title: Qlik Sense Enterprise Qlik Sense Repository Service Content…
  description: Core REST API for managing Qlik Sense Enterprise resources including apps, streams, users, security rules, and all configuration available through the Qlik Management Console (QMC). The QRS API provides CRUD operations for all entity types in the Qlik Sense repository, enabling programmatic administration of a Qlik Sense Enterprise 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-repository-service
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
security:
- xrfkey: []
- certificate: []
- windowsAuth: []
tags:
- name: Content Library
  description: Manage shared and app-specific content libraries
paths:
  /contentlibrary:
    get:
      operationId: getContentLibraries
      summary: Qlik Sense Enterprise List content libraries
      description: Retrieves a list of all content libraries in condensed format.
      tags:
      - Content Library
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of content libraries returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContentLibraryCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /contentlibrary/{id}/uploadfile:
    post:
      operationId: uploadContentLibraryFile
      summary: Qlik Sense Enterprise Upload file to content library
      description: Uploads a file to a content library. The file is sent as the request body and the relative path within the library is specified as a query parameter.
      tags:
      - Content Library
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      - name: externalpath
        in: query
        required: true
        description: Relative path within the content library for the uploaded file
        schema:
          type: string
      - name: overwrite
        in: query
        description: Whether to overwrite an existing file
        schema:
          type: boolean
          default: false
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: File uploaded successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /contentlibrary/{id}/deletecontent:
    delete:
      operationId: deleteContentLibraryFile
      summary: Qlik Sense Enterprise Delete file from content library
      description: Deletes a file from a content library by its external path.
      tags:
      - Content Library
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      - name: externalpath
        in: query
        required: true
        description: Relative path of the file to delete within the content library
        schema:
          type: string
      responses:
        '204':
          description: File deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
    ContentLibraryCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
  parameters:
    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
    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
    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
  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'
    NotFound:
      description: The requested entity was not found.
      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 and must match the Xrfkey query parameter.
    certificate:
      type: mutualTLS
      description: Client certificate authentication using certificates exported from Qlik Sense. Used when connecting directly to QRS on port 4242.
    windowsAuth:
      type: http
      scheme: negotiate
      description: Windows Integrated Authentication (NTLM/Kerberos) used when connecting via the Qlik Sense Proxy Service.