Namespaces for REST and Events APIs are being introduced in Qlik Cloud to support the growing number of APIs and services in the platform, and to unlock versioning support in the future. This change makes it easier for you to find, understand, and use Qlik APIs by grouping related resources by context, as well as standardizing the interface for the APIs.
The new namespaced APIs will be introduced in parallel with the existing APIs.
The existing APIs will be deprecated and removed after aminimum12-month deprecation period from the notice of deprecation on thechangelog (qlik.dev).
No immediate action is needed. As each API is namespaced, a deprecation notice will be published with migration guides.
Key changes
REST
Removal ofv1from the path:v1will be removed from the path to prepare for versioning support in the future.
Grouping resources by context: Related APIs will be grouped together under a namespace which indicates in which context the resources are applicable. For example:
Theanalyticsnamespace for Analytics-specific resources such as apps, notes, and ODAGs apps.
Thecorenamespace for platform-wide resources such as users, groups, ip-policies, and roles.
Standardization of interfaces: The payloads for the new namespaced APIs will be standardized to be compliant with Qlik’s API design principles, meaning improved consistency of payloads, query parameters, and response formats between different APIs, irrespective of the context.
Events
Events will adhere to the same namespace rule to avoid conflict of resource names and to match the REST resources. This changes the pattern fromcom.qlik.v<version>.<eventContext>.<action>tocom.qlik.<namespace>.<eventContext>.<action>.
