Qlik Sense Enterprise Stream API

openapi: 3.2.0
info:
  title: Qlik Sense Enterprise Qlik Sense Repository Service Stream…
  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: Stream
  description: Manage streams for organizing and distributing apps
paths:
  /stream:
    get:
      operationId: getStreams
      summary: Qlik Sense Enterprise List streams
      description: Retrieves a list of all streams in condensed format, optionally filtered by a query expression.
      tags:
      - Stream
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      - $ref: '#/components/parameters/OrderByParam'
      - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: List of streams returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StreamCondensed'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createStream
      summary: Qlik Sense Enterprise Create stream
      description: Creates a new stream for organizing and distributing published applications.
      tags:
      - Stream
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Stream'
      responses:
        '201':
          description: Stream created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /stream/full:
    get:
      operationId: getStreamsFull
      summary: Qlik Sense Enterprise List streams with full details
      description: Retrieves a list of all streams in full format including owner, custom properties, and tags.
      tags:
      - Stream
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      - $ref: '#/components/parameters/OrderByParam'
      - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Full list of streams returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Stream'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /stream/count:
    get:
      operationId: getStreamsCount
      summary: Qlik Sense Enterprise Count streams
      description: Returns the number of streams matching an optional filter expression.
      tags:
      - Stream
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/FilterParam'
      responses:
        '200':
          description: Stream count returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityCount'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /stream/{id}:
    get:
      operationId: getStream
      summary: Qlik Sense Enterprise Get stream by ID
      description: Retrieves a single stream by its unique identifier in full format.
      tags:
      - Stream
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      - $ref: '#/components/parameters/PrivilegesParam'
      responses:
        '200':
          description: Stream returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateStream
      summary: Qlik Sense Enterprise Update stream
      description: Updates an existing stream. The complete entity with unchanged modifiedDate must be provided.
      tags:
      - Stream
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Stream'
      responses:
        '200':
          description: Stream updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteStream
      summary: Qlik Sense Enterprise Delete stream
      description: Permanently deletes a stream. Published apps in the stream are unpublished.
      tags:
      - Stream
      parameters:
      - $ref: '#/components/parameters/XrfKeyParam'
      - $ref: '#/components/parameters/IdParam'
      responses:
        '204':
          description: Stream deleted successfully
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    TagCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
    UserCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        userDirectory:
          type: string
        userId:
          type: string
        privileges:
          type: array
          items:
            type: string
    EntityCount:
      type: object
      properties:
        value:
          type: integer
          description: Number of entities matching the filter
    StreamCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        privileges:
          type: array
          items:
            type: string
    CustomPropertyValue:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        modifiedByUserName:
          type: string
        definition:
          $ref: '#/components/schemas/CustomPropertyCondensed'
        value:
          type: string
        schemaPath:
          type: string
    Stream:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        modifiedByUserName:
          type: string
        name:
          type: string
          description: Stream name
        owner:
          $ref: '#/components/schemas/UserCondensed'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCondensed'
        customProperties:
          type: array
          items:
            $ref: '#/components/schemas/CustomPropertyValue'
        privileges:
          type: array
          items:
            type: string
        schemaPath:
          type: string
      required:
      - name
    CustomPropertyCondensed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        valueType:
          type: string
        privileges:
          type: array
          items:
            type: string
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
  responses:
    NotFound:
      description: The requested entity was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    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'
    Conflict:
      description: Update conflict. The entity has been modified since it was last retrieved. Fetch the latest version and retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request. The request body or parameters are malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    IdParam:
      name: id
      in: path
      required: true
      description: Unique identifier (GUID) of the entity
      schema:
        type: string
        format: uuid
    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
    PrivilegesParam:
      name: privileges
      in: query
      required: false
      description: Whether to append privilege information to the returned entities.
      schema:
        type: boolean
        default: false
    OrderByParam:
      name: orderby
      in: query
      required: false
      description: Property name to order results by, optionally followed by asc or desc.
      schema:
        type: string
    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
  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.