qsAPI

What it is and what it does

qsAPI wraps the Qlik Sense QPS (Qlik Proxy Service) and QRS (Qlik Repository Service) REST APIs into a Python client, letting you automate administrative tasks on a Qlik Sense site. It depends only on requests and provides both a Python API (with classes like QRS and QPS) and a command-line interface for common operations like exporting applications, managing users, retrieving security rules, and duplicating apps.

The package is designed for administrators and automation engineers who need to script Qlik Sense management tasks. It supports authentication via exported client certificates or Windows NTLM credentials. However, the project has been abandoned since October 2020—no updates, security patches, or compatibility fixes have been released in over five years, which is a significant risk if you depend on it for production automation.

Use it for:

• Automate bulk export of Qlik Sense applications to a file system for backup or migration.
• Script user and session management tasks, such as counting users or terminating sessions programmatically.
• Retrieve and filter security rules and configuration settings from a Qlik Sense repository.
• Build custom administrative dashboards or tools that interact with Qlik Sense via Python.
• Integrate Qlik Sense management into CI/CD pipelines or scheduled maintenance workflows.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

qsAPI is a Python client for Qlik Sense QPS and QRS REST APIs that lets you manage Qlik Sense sites programmatically—viewing and editing configuration, managing tasks, and automating administrative operations.

Yes, but only if you are managing a Qlik Sense deployment that has not been updated since 2020 and you understand the risks of using abandoned software. The package is lightweight and permissively licensed, but the lack of maintenance means no security updates, no compatibility fixes for newer Python or Qlik versions, and no support for emerging authentication methods. If your Qlik Sense environment is actively maintained or you need long-term reliability, evaluate whether the vendor's official APIs or a maintained fork would be safer.

Install

qsapi on PyPI

pip install qsapi

uv add qsapi

poetry add qsapi

Installing qsAPI

Before you install

Installation is straightforward with low friction—a single runtime dependency (requests) and a pure-Python wheel. However, the project is abandoned; the last commit was 2020-10-22 and no updates have been released since. Security and compatibility fixes are unlikely.

License in practice

Licensed under MIT (permissive), so you can use, modify, and distribute the package freely with minimal restrictions.

Quickstart

pip install qsAPI

import qsAPI
qrs = qsAPI.QRS(proxy='hostname', certificate='path/client.pem')
qrs.count('user', "Name eq 'sa_repository'")

Requires a Qlik Sense server to connect to and either a client certificate or Windows credentials (NTLM) for authentication.

Verify before relying

• Whether the package works with current versions of Qlik Sense (last tested in 2020).
• Compatibility with modern Python versions and the requests library—no minimum Python version is specified.
• Whether NTLM authentication (optional install target) still functions with current Windows/domain setups.

Package facts

Evidence: qsAPI-2.2.0-py3-none-any.whl

Tags

More WWW/HTTP packages