Qlik Cloud REST API

Main REST API for Qlik Cloud providing access to apps, spaces, users, and resources.

OpenAPI Specification

qlik-cloud-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Qlik Cloud REST API
  description: Qlik Cloud REST API for managing users, apps, spaces, groups, data connections, reports, OAuth clients, API keys, and webhooks.
  version: 1.0.0
  x-generated-from: https://qlik.dev/apis/rest
  x-generated-by: claude-crawl-2026-05-08
servers:
  - url: https://your-tenant.region.qlikcloud.com
    description: Qlik Cloud tenant
security:
  - bearerAuth: []
paths:
  /api/v1/users:
    get:
      summary: List users
      operationId: listUsers
      responses:
        '200': { description: User list, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } }
    post:
      summary: Create an invited user
      operationId: createUser
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses:
        '201': { description: User created, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } }
  /api/v1/users/{userId}:
    parameters:
      - { in: path, name: userId, required: true, schema: { type: string } }
    get:
      summary: Get user
      operationId: getUser
      responses: { '200': { description: User details, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    patch:
      summary: Update user
      operationId: updateUser
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '200': { description: User updated, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    delete:
      summary: Delete user
      operationId: deleteUser
      responses: { '204': { description: Deleted } }
  /api/v1/users/me:
    get:
      summary: Get current user
      operationId: getCurrentUser
      responses: { '200': { description: Current user, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/users/actions/count:
    get:
      summary: Count users
      operationId: countUsers
      responses: { '200': { description: User count, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/users/actions/filter:
    post:
      summary: Filter users
      operationId: filterUsers
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '200': { description: Filter result, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/users/actions/invite:
    post:
      summary: Invite users
      operationId: inviteUsers
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '200': { description: Invitations sent, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/apps:
    post:
      summary: Create app
      operationId: createApp
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '201': { description: App created, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/apps/{appId}:
    parameters:
      - { in: path, name: appId, required: true, schema: { type: string } }
    get:
      summary: Get app
      operationId: getApp
      responses: { '200': { description: App details, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    put:
      summary: Update app
      operationId: updateApp
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '200': { description: App updated, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    delete:
      summary: Delete app
      operationId: deleteApp
      responses: { '204': { description: Deleted } }
  /api/v1/apps/{appId}/copy:
    parameters:
      - { in: path, name: appId, required: true, schema: { type: string } }
    post:
      summary: Copy app
      operationId: copyApp
      responses: { '200': { description: App copied, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/apps/{appId}/publish:
    parameters:
      - { in: path, name: appId, required: true, schema: { type: string } }
    post:
      summary: Publish app
      operationId: publishApp
      responses: { '200': { description: App published, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    put:
      summary: Republish app
      operationId: republishApp
      responses: { '200': { description: App republished, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/apps/{appId}/data/lineage:
    parameters:
      - { in: path, name: appId, required: true, schema: { type: string } }
    get:
      summary: Get app data lineage
      operationId: getAppLineage
      responses: { '200': { description: Lineage data, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/apps/{appId}/data/metadata:
    parameters:
      - { in: path, name: appId, required: true, schema: { type: string } }
    get:
      summary: Get app metadata
      operationId: getAppMetadata
      responses: { '200': { description: App metadata, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/spaces:
    get:
      summary: List spaces
      operationId: listSpaces
      responses: { '200': { description: Space list, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    post:
      summary: Create space
      operationId: createSpace
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '201': { description: Space created, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/spaces/{spaceId}:
    parameters:
      - { in: path, name: spaceId, required: true, schema: { type: string } }
    get:
      summary: Get space
      operationId: getSpace
      responses: { '200': { description: Space details, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    patch:
      summary: Patch space
      operationId: patchSpace
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '200': { description: Space patched, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    put:
      summary: Update space
      operationId: updateSpace
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '200': { description: Space updated, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    delete:
      summary: Delete space
      operationId: deleteSpace
      responses: { '204': { description: Deleted } }
  /api/v1/spaces/{spaceId}/assignments:
    parameters:
      - { in: path, name: spaceId, required: true, schema: { type: string } }
    get:
      summary: List space assignments
      operationId: listSpaceAssignments
      responses: { '200': { description: Assignment list, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    post:
      summary: Create space assignment
      operationId: createSpaceAssignment
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '201': { description: Assignment created, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/spaces/types:
    get:
      summary: List space types
      operationId: listSpaceTypes
      responses: { '200': { description: Type list, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/api-keys:
    get:
      summary: List API keys
      operationId: listApiKeys
      responses: { '200': { description: API key list, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    post:
      summary: Create API key
      operationId: createApiKey
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '201': { description: API key created, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/webhooks:
    get:
      summary: List webhooks
      operationId: listWebhooks
      responses: { '200': { description: Webhook list, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
    post:
      summary: Create webhook
      operationId: createWebhook
      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/GenericRequest' } } } }
      responses: { '201': { description: Webhook created, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
  /api/v1/csrf-token:
    get:
      summary: Get CSRF token
      operationId: getCsrfToken
      responses: { '200': { description: CSRF token, content: { application/json: { schema: { $ref: '#/components/schemas/GenericResponse' } } } } }
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
  schemas:
    GenericRequest:
      type: object
      additionalProperties: true
    GenericResponse:
      type: object
      additionalProperties: true