qsAPI 2.2.0

qsAPI - a client for Qlik Sense QPS and QRS interfaces

About

qsAPI is a client for Qlik Sense QPS and QRS interfaces written in python that provides an environment for managing a Qlik Sense site via programming or interactive console. The module provides a set of commands for viewing and editing configuration settings, as well as managing tasks and other features available through APIs.

Installation

You could use your preferred IDE (Eclipse, Visual Code, NetBeans, etc.) with the python interpreter 3.x or directly in console. Take a look at (https://www.python.org). Once the module is loaded you can view a list of available commands with the autocomplete tooltips.

Just execute in the command line (libraries and dependencies will be installed):

pip install qsAPI

Optionally, if you plan connect using NTLM authentication, then append optional target.

pip install qsAPI[ntlm]

Now, the module can be used just importing qsAPI.py at the beginning of your python script or console, the module will then be loaded and ready to use.

>>> import qsAPI

Or just a simple command line console if complex scripts are no needed:

Usage

Connecting with certificates

The first step is to build a handler invoking the constructor of the class you will use containing the host parameters, this will attempt to connect to the Qlik Sense server. Just export previously from QlikSense console the certificate in portable format and copy the folder in your machine:

>>> qrs=qsAPI.QRS(proxy='hostname', certificate='path\\client.pem')

Connecting with windows credentials (NTLM)

Alternatively, the constructor accept user credentials via arguments.

>>> qrs=qsAPI.QRS(proxy='hostname', user=('yor_domain','username','password'))

Examples

Count users using a filter

qrs.count('user',"Name eq 'sa_repository'")

Duplicate an application in the server

qrs.AppCopy('a99babf2-3c9d-439d-99d2-66fa7276604e',"HELLO world")

Export an application

qrs.AppExport('a99babf2-3c9d-439d-99d2-66fa7276604e',"c:\\path\\myAppName.qvf")

Export all published applications to directories

for app in qrs.AppGet(pFilter="stream.name ne 'None'"):
	os.makedirs(app['stream']['name'], exist_ok=True)
	qrs.AppExport(app['id'], app['stream']['name']+'\\'+app['name'])

Retrieve security rules using a filter

qrs.SystemRulesGet("type eq 'Custom'")

Retrieve a list of sessions for a user

[x['SessionId'] for x in qps.GetUser('DIR', 'name').json()]

teardown of all connections for the user and related sessions

qps.DeleteUser('DIR','name')

More examples

Take a look at the Wiki area: (https://github.com/rafael-sanz/qsAPI/wiki)

Command Line

Alternative use as command line is available too, examples:

qsAPI --help
qsAPI -s myServer -c dir/client.pem -Q QRS TaskStartbyName "Reload License Monitor"
qsAPI -s myServer -c dir/client.pem -Q QRS -v INFO AppExport d8b120d7-a6e4-42ff-90b2-2ac6a3d92233
qsAPI -s myServer -c dir/client.pem -Q QRS -v INFO AppReload 79f0c591-67de-4ded-91ae-4865934a5746

TODO

The module is in progress, a subset of methods are implemented. But all the endpoints could be implemented through the inner class driver and the methods get, post, put, delete.

qps.driver.get('/qrs/about/api/enums')

License

This software is made available "AS IS" without warranty of any kind. Qlik support agreement does not cover support for this software.