Skip to main content Skip to complementary content

API paths

This section describes the API paths (that is, endpoints) available in the Qlik Sense Repository Service (QRS) API.

Example:  

When communicating directly with the QRS API, the URL is as follows:

https://<QRS machine name>:4242/<path>

See: QRS API URLs

To call a path, replace <path> with a proper path, such as:

/qrs/[type]/count?filter={filter}

In this example, the Get count path is used.

In the path, replace [type] with a proper entity type:

/qrs/user/count?filter={filter}

In this example, the user entity type is used.

Optionally, filter the returned entities:

/qrs/user/count?filter=Name eq 'Joe Smith'

In this example, only users named “Joe Smith” are included.

See: Optional parameters

This means that the URL becomes:

https://<QRS machine name>:4242/qrs/user/count?filter=Name eq 'Joe Smith'

Information noteCalls to the QRS API must include Xrfkey headers. See Using Xrfkey headers for information on how to apply the headers.
Tip noteMany JSON structs in the Qlik Sense Repository Service (QRS) API include the modifiedDate property, which is used to avoid conflicts in the repository database. For example, when updating an entity, leave the modifiedDate property unchanged. If the modifiedDate property for the updated entity differs from the modifiedDate property for the entity in the QRS, there is a conflict (that is, the entity in the QRS has already been updated by someone else).

About: Get

About API: Get all defaults

About API: Get type

About API: Get description

About API: Get relations

About API: Get enums

Access type information: Get access type information

Access type: Add User access type by selection

App content: Upload file

App content: Delete content

App: Export app (call 1 of 2)

App: Export app (call 2 of 2)

App object: Get privileges

App object: Publish

App object: Unpublish

App: Migrate

App: Make copy

App: Publish

App: Replace

App: Reload

App: Get state

App: Upload app

App: Import app

Cache: Invalidate

Certificate distribution: Export certificates

Certificate distribution: Export certificates path

Certificate distribution: Distribute certificate

Certificate distribution: Redistribute certificate

Certificate installation: Install certificate

Certificate installation: Setup ping

Content library: Upload file

Content library: Delete content

Data market: Get license

Data market: Add license

Data market: Update license

Engine service: Get local engine service

Extension: Get schemas

Extension: Upload extension

Extension: Create extension with schema

Extension: Delete extension by name

Extension: Create or update a file in an extension

Extension: Delete a file from an extension

License: Download LEF

License: Get

License: Add

License: Update

License rule audit: Get audit rules

License rule audit: Preview audit rules

License rule: Get user actions

Load balancing: Get valid engines

Notification: Add change subscription

Notification: Remove change subscription

Notification: Get changes since

Ping: Ping

Proxy service: Get local proxy service

Reload task: Add reload task bundle

Reload task: Update reload task bundle

Access type: Request access type

SAML: Metadata download (call 1 of 2)

SAML: Metadata download (call 2 of 2)

Scheduler service: Get local scheduler service

Security rule audit: Get audit export

Security rule audit: Get resource count

Security rule audit: Get audit rules

Security rule audit: Get audit preview

Security rule audit: Get accessible objects

Security rule: Get accessible attributes

Security rule: Get attribute values

Security rule: Get referenced user roles

Security rule: Get parse tree

Security rule: Get user actions

Security rule: Get allowed resources

Server node configuration: Get server node creation container

Server node configuration: Add server node creation container

Service registration: Start service registration

Service registration: Add server node configuration

Service status: Get service state

Static content: Enumerate files

Synchronization: Create snapshot

Synchronization rule audit: Get audit rules

Synchronization rule audit: Preview audit rules

Synchronization rule: Get linked nodes

Synchronization rule: Get linked objects

System rule: Get associated rules

Task: Start

Task: Start asynchronous

Task: Start by name

Task: Start by name asynchronously

Task: Start many

Task: Stop

Task: Stop many

User directory: Get all default settings

User directory: Refresh user directory types

User directory: Sync user directories

User directory: Delete user directory and users

User: Owned resources

User: Synchronize user

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!