This documentation describes the Qlik Sense Repository Service (QRS) API.
The QRS contains all data and configuration information for a Qlik Sense site. The data is normally added and updated using the Qlik Management Console (QMC) or a Qlik Sense client, but it is also possible to communicate directly with the QRS using its API. This enables the automation of a range of tasks, for example:
- Start tasks from an external scheduling tool
- Change license configurations
- Extract data about the system
The QRS API is delivered as a REpresentational State Transfer (REST) web service that contains a number of endpoints (also referred to as paths) that are used to execute various functions. To communicate with these endpoints, http calls that contain GET, POST, PUT, or DELETE requests are made.
The content sent to and received from the endpoints is normally formatted as JSON structures and in some cases as files. For example, if a GET request is submitted to the /qrs/app endpoint, the user receives a list of all apps in the system formatted as a JSON structure.
To communicate with the endpoints securely, the requests must be made with some specific settings as described in this documentation.