Tenant settings
The Tenant Settings API provides access to tenant-wide configuration options for security policies, user interface customization, and operational preferences that affect all users in your tenant.
Endpoints
Retrieves tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:read.
Facts
| Rate limit | Tier 1 (1000 requests per minute) |
Responses
200
Tenant settings retrieval was successful.
- application/json object
application/json properties
- id stringRequired
- tenantId stringRequired
- createdAt stringRequired
- createdBy stringRequired
userId of the user who created the settings
- updatedAt stringRequired
- updatedBy string
userId of the user who last modified the settings
- releaseCadence string
Set the release cadence
Can be one of: "monthly""continuous"
- customizeNoAccess object
customizeNoAccess properties
- linkUrl string
- message string
- linkLabel string
- linkEnabled booleanRequired
-
- preferredStartPage objectOne of:
- StartPageConfigHub object
StartPageConfigHub properties
- route string
Can be one of: "/insights"
- value string
Can be one of: "analytics-hub"
-
- StartPageConfigCreationHub object
StartPageConfigCreationHub properties
- route string
Can be one of: "/analytics"
- value string
Can be one of: "analytics-creation-hub"
-
- StartPageConfigQdi object
StartPageConfigQdi properties
- route string
Can be one of: "/qdi"
- value string
Can be one of: "data-integration-hub"
-
- StartPageConfigConsole object
StartPageConfigConsole properties
- route string
Can be one of: "/console"
- value string
Can be one of: "management-console"
-
-
- publicPreviewOptIn boolean
Whether the tenant has opted in to public preview features.
- sessionReplayOptOut boolean
Tenant-wide preference for opting out of session replay. When set, this value overrides individual user preferences. EU regions default to true (opted out) if this is not explicitly configured.
- crossRegionDataProcessing boolean
Set to true to enable cross-region inference, false to disable.
-
default
Error response.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.tenantSettings.getTenantSettings()qlik tenant-settings lscurl "https://{tenant}.{region}.qlikcloud.com/api/v1/tenant-settings" \-H "Authorization: Bearer <access_token>"Example Response
{ "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "createdAt": "2024-01-01T00:00:00.000Z", "createdBy": "string", "updatedAt": "2024-01-01T00:00:00.000Z", "updatedBy": "string", "releaseCadence": "monthly", "customizeNoAccess": { "linkUrl": "string", "message": "string", "linkLabel": "string", "linkEnabled": true }, "preferredStartPage": { "route": "/insights", "value": "analytics-hub" }, "publicPreviewOptIn": false, "sessionReplayOptOut": true, "crossRegionDataProcessing": true}Creates a new tenant settings entry for the tenant ID specified in the JWT. This is access controlled by the permission admin.tenant-settings:create.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
Request Body
Required- application/json object
Create a new tenant settings entry for the tenant ID specified in the JWT. At least one of preferredStartPage or customizeNoAccess must be provided.
application/json properties
- customizeNoAccess object
customizeNoAccess properties
- linkUrl string
- message string
- linkLabel string
- linkEnabled booleanRequired
-
- preferredStartPage string
Can be one of: "analytics-hub""data-integration-hub""management-console""analytics-creation-hub"
-
Responses
201
The tenant settings have been successfully created.
- application/json object
application/json properties
- id stringRequired
- tenantId stringRequired
- createdAt stringRequired
- createdBy stringRequired
userId of the user who created the settings
- updatedAt stringRequired
- updatedBy string
userId of the user who last modified the settings
- releaseCadence string
Set the release cadence
Can be one of: "monthly""continuous"
- customizeNoAccess object
customizeNoAccess properties
- linkUrl string
- message string
- linkLabel string
- linkEnabled booleanRequired
-
- preferredStartPage objectOne of:
- StartPageConfigHub object
StartPageConfigHub properties
- route string
Can be one of: "/insights"
- value string
Can be one of: "analytics-hub"
-
- StartPageConfigCreationHub object
StartPageConfigCreationHub properties
- route string
Can be one of: "/analytics"
- value string
Can be one of: "analytics-creation-hub"
-
- StartPageConfigQdi object
StartPageConfigQdi properties
- route string
Can be one of: "/qdi"
- value string
Can be one of: "data-integration-hub"
-
- StartPageConfigConsole object
StartPageConfigConsole properties
- route string
Can be one of: "/console"
- value string
Can be one of: "management-console"
-
-
- publicPreviewOptIn boolean
Whether the tenant has opted in to public preview features.
- sessionReplayOptOut boolean
Tenant-wide preference for opting out of session replay. When set, this value overrides individual user preferences. EU regions default to true (opted out) if this is not explicitly configured.
- crossRegionDataProcessing boolean
Set to true to enable cross-region inference, false to disable.
-
400
Bad Request
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- detail string
- status integer
-
- traceId string
-
401
Unauthorized
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- detail string
- status integer
-
- traceId string
-
403
Forbidden
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- detail string
- status integer
-
- traceId string
-
500
Internal Server Error
- application/json object
application/json properties
- errors array of objects
errors properties
- code string
- title string
- detail string
- status integer
-
- traceId string
-
default
Error response.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.tenantSettings.createTenantSettings({ customizeNoAccess: { linkEnabled: true, linkLabel: 'string', linkUrl: 'string', message: 'string', }, preferredStartPage: 'analytics-hub',})qlik tenant-settings create \ --customizeNoAccess-linkEnabled truecurl "https://{tenant}.{region}.qlikcloud.com/api/v1/tenant-settings" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"customizeNoAccess":{"linkUrl":"string","message":"string","linkLabel":"string","linkEnabled":true},"preferredStartPage":"analytics-hub"}'Example Response
{ "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "createdAt": "2024-01-01T00:00:00.000Z", "createdBy": "string", "updatedAt": "2024-01-01T00:00:00.000Z", "updatedBy": "string", "releaseCadence": "monthly", "customizeNoAccess": { "linkUrl": "string", "message": "string", "linkLabel": "string", "linkEnabled": true }, "preferredStartPage": { "route": "/insights", "value": "analytics-hub" }, "publicPreviewOptIn": false, "sessionReplayOptOut": true, "crossRegionDataProcessing": true}Updates existing tenant settings. This is access controlled by the permission admin.tenant-settings:update.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
Request Body
Required- application/json array of objectsOne of:
- JSONPatchRequestAddReplaceTest object
JSONPatchRequestAddReplaceTest properties
- op stringRequired
The operation to perform.
Can be one of: "add""replace""test"
- path stringRequired
A JSON Pointer path.
- value anyRequired
The value to add, replace or test.
-
- JSONPatchRequestRemove object
JSONPatchRequestRemove properties
- op stringRequired
The operation to perform.
Can be one of: "remove"
- path stringRequired
A JSON Pointer path.
-
- JSONPatchRequestMoveCopy object
JSONPatchRequestMoveCopy properties
- op stringRequired
The operation to perform.
Can be one of: "move""copy"
- from stringRequired
A JSON Pointer path.
- path stringRequired
A JSON Pointer path.
-
-
Responses
200
The tenant settings have been successfully updated.
- application/json object
application/json properties
- id stringRequired
- tenantId stringRequired
- createdAt stringRequired
- createdBy stringRequired
userId of the user who created the settings
- updatedAt stringRequired
- updatedBy string
userId of the user who last modified the settings
- releaseCadence string
Set the release cadence
Can be one of: "monthly""continuous"
- customizeNoAccess object
customizeNoAccess properties
- linkUrl string
- message string
- linkLabel string
- linkEnabled booleanRequired
-
- preferredStartPage objectOne of:
- StartPageConfigHub object
StartPageConfigHub properties
- route string
Can be one of: "/insights"
- value string
Can be one of: "analytics-hub"
-
- StartPageConfigCreationHub object
StartPageConfigCreationHub properties
- route string
Can be one of: "/analytics"
- value string
Can be one of: "analytics-creation-hub"
-
- StartPageConfigQdi object
StartPageConfigQdi properties
- route string
Can be one of: "/qdi"
- value string
Can be one of: "data-integration-hub"
-
- StartPageConfigConsole object
StartPageConfigConsole properties
- route string
Can be one of: "/console"
- value string
Can be one of: "management-console"
-
-
- publicPreviewOptIn boolean
Whether the tenant has opted in to public preview features.
- sessionReplayOptOut boolean
Tenant-wide preference for opting out of session replay. When set, this value overrides individual user preferences. EU regions default to true (opted out) if this is not explicitly configured.
- crossRegionDataProcessing boolean
Set to true to enable cross-region inference, false to disable.
-
404
Tenant settings for this tenant do not exist.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
default
Error response.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.tenantSettings.updateTenantSettings([ { op: 'add', path: 'string' },])qlik tenant-settings patch \ --value \ --from ''curl "https://{tenant}.{region}.qlikcloud.com/api/v1/tenant-settings" \-X PATCH \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '[{"op":"add","path":"string"}]'Example Response
{ "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "createdAt": "2024-01-01T00:00:00.000Z", "createdBy": "string", "updatedAt": "2024-01-01T00:00:00.000Z", "updatedBy": "string", "releaseCadence": "monthly", "customizeNoAccess": { "linkUrl": "string", "message": "string", "linkLabel": "string", "linkEnabled": true }, "preferredStartPage": { "route": "/insights", "value": "analytics-hub" }, "publicPreviewOptIn": false, "sessionReplayOptOut": true, "crossRegionDataProcessing": true}Deletes the tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:delete.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
Responses
204
The tenant settings have been successfully deleted.
404
Tenant settings for tenant ID do not exist.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
default
Error response.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.tenantSettings.deleteTenantSettings()qlik tenant-settings delete-manycurl "https://{tenant}.{region}.qlikcloud.com/api/v1/tenant-settings" \-X DELETE \-H "Authorization: Bearer <access_token>"Sets the cross region inference setting for the tenant. Creates tenant settings if none exist, or updates existing settings. This is access controlled by the permission admin.tenant-settings:update.
When cross-region processing is required, you must include an additional header x-qlik-consent-verified: true in your API requests to confirm that you have the authority to enable this feature and accept the associated terms.
Facts
| Rate limit | Tier 2 (100 requests per minute) | |
| Deprecated | This endpoint is deprecated and will eventually be removed. Read our API policy here. | |
| Deprecated sunset | 2026-05 | |
| Deprecated description | Use `/tenant-settings/actions/toggle-cross-region-inference` instead. This endpoint uses outdated terminology. |
Request Body
Required- application/json object
Set to true to enable cross-region inference, false to disable. Defaults to false.
application/json properties
- value booleanRequired
Set to true to enable cross-region inference, false to disable.
-
Responses
200
The cross region inference setting has been successfully updated.
- application/json object
application/json properties
- id stringRequired
- tenantId stringRequired
- createdAt stringRequired
- createdBy stringRequired
userId of the user who created the settings
- updatedAt stringRequired
- updatedBy string
userId of the user who last modified the settings
- releaseCadence string
Set the release cadence
Can be one of: "monthly""continuous"
- customizeNoAccess object
customizeNoAccess properties
- linkUrl string
- message string
- linkLabel string
- linkEnabled booleanRequired
-
- preferredStartPage objectOne of:
- StartPageConfigHub object
StartPageConfigHub properties
- route string
Can be one of: "/insights"
- value string
Can be one of: "analytics-hub"
-
- StartPageConfigCreationHub object
StartPageConfigCreationHub properties
- route string
Can be one of: "/analytics"
- value string
Can be one of: "analytics-creation-hub"
-
- StartPageConfigQdi object
StartPageConfigQdi properties
- route string
Can be one of: "/qdi"
- value string
Can be one of: "data-integration-hub"
-
- StartPageConfigConsole object
StartPageConfigConsole properties
- route string
Can be one of: "/console"
- value string
Can be one of: "management-console"
-
-
- publicPreviewOptIn boolean
Whether the tenant has opted in to public preview features.
- sessionReplayOptOut boolean
Tenant-wide preference for opting out of session replay. When set, this value overrides individual user preferences. EU regions default to true (opted out) if this is not explicitly configured.
- crossRegionDataProcessing boolean
Set to true to enable cross-region inference, false to disable.
-
400
Bad Request. The request is incorrect.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
401
Unauthorized. The user is not authorized to access the service.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
403
Forbidden. You don't have sufficient permissions to access this resource.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
default
Error response.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.tenantSettings.toggleCrossRegionDataProcessingTenantSettings( { value: true },)# qlik-cli has not implemented support for POST /api/v1/tenant-settings/actions/toggle-cross-region-data-processing yet.curl "https://{tenant}.{region}.qlikcloud.com/api/v1/tenant-settings/actions/toggle-cross-region-data-processing" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"value":true}'Example Response
{ "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "createdAt": "2024-01-01T00:00:00.000Z", "createdBy": "string", "updatedAt": "2024-01-01T00:00:00.000Z", "updatedBy": "string", "releaseCadence": "monthly", "customizeNoAccess": { "linkUrl": "string", "message": "string", "linkLabel": "string", "linkEnabled": true }, "preferredStartPage": { "route": "/insights", "value": "analytics-hub" }, "publicPreviewOptIn": false, "sessionReplayOptOut": true, "crossRegionDataProcessing": true}Sets the cross-region inference setting for the tenant. Creates tenant settings if none exist, or updates existing settings. This is access controlled by the permission admin.tenant-settings:update.
When cross-region inference is required, you must include an additional header x-qlik-consent-verified: true in your API requests to confirm that you have the authority to enable this feature and accept the associated terms.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
Request Body
Required- application/json object
Set to true to enable cross-region inference, false to disable. Defaults to false.
application/json properties
- value booleanRequired
Set to true to enable cross-region inference, false to disable.
-
Responses
200
The cross region inference setting has been successfully updated.
- application/json object
application/json properties
- id stringRequired
- tenantId stringRequired
- createdAt stringRequired
- createdBy stringRequired
userId of the user who created the settings
- updatedAt stringRequired
- updatedBy string
userId of the user who last modified the settings
- releaseCadence string
Set the release cadence
Can be one of: "monthly""continuous"
- customizeNoAccess object
customizeNoAccess properties
- linkUrl string
- message string
- linkLabel string
- linkEnabled booleanRequired
-
- preferredStartPage objectOne of:
- StartPageConfigHub object
StartPageConfigHub properties
- route string
Can be one of: "/insights"
- value string
Can be one of: "analytics-hub"
-
- StartPageConfigCreationHub object
StartPageConfigCreationHub properties
- route string
Can be one of: "/analytics"
- value string
Can be one of: "analytics-creation-hub"
-
- StartPageConfigQdi object
StartPageConfigQdi properties
- route string
Can be one of: "/qdi"
- value string
Can be one of: "data-integration-hub"
-
- StartPageConfigConsole object
StartPageConfigConsole properties
- route string
Can be one of: "/console"
- value string
Can be one of: "management-console"
-
-
- publicPreviewOptIn boolean
Whether the tenant has opted in to public preview features.
- sessionReplayOptOut boolean
Tenant-wide preference for opting out of session replay. When set, this value overrides individual user preferences. EU regions default to true (opted out) if this is not explicitly configured.
- crossRegionDataProcessing boolean
Set to true to enable cross-region inference, false to disable.
-
400
Bad Request. The request is incorrect.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
401
Unauthorized. The user is not authorized to access the service.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
403
Forbidden. You don't have sufficient permissions to access this resource.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
default
Error response.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.tenantSettings.toggleCrossRegionInferenceTenantSettings( { value: true },)qlik tenant-settings toggle-cross-region-inference \ --value truecurl "https://{tenant}.{region}.qlikcloud.com/api/v1/tenant-settings/actions/toggle-cross-region-inference" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"value":true}'Example Response
{ "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "createdAt": "2024-01-01T00:00:00.000Z", "createdBy": "string", "updatedAt": "2024-01-01T00:00:00.000Z", "updatedBy": "string", "releaseCadence": "monthly", "customizeNoAccess": { "linkUrl": "string", "message": "string", "linkLabel": "string", "linkEnabled": true }, "preferredStartPage": { "route": "/insights", "value": "analytics-hub" }, "publicPreviewOptIn": false, "sessionReplayOptOut": true, "crossRegionDataProcessing": true}Retrieves start pages for the tenant settings.
Facts
| Rate limit | Tier 1 (1000 requests per minute) |
Responses
200
Tenant settings start pages retrieval was successful.
- application/json object
application/json properties
- values array of objectsRequiredAny of:
- StartPageConfigHub object
StartPageConfigHub properties
- route string
Can be one of: "/insights"
- value string
Can be one of: "analytics-hub"
-
- StartPageConfigCreationHub object
StartPageConfigCreationHub properties
- route string
Can be one of: "/analytics"
- value string
Can be one of: "analytics-creation-hub"
-
- StartPageConfigQdi object
StartPageConfigQdi properties
- route string
Can be one of: "/qdi"
- value string
Can be one of: "data-integration-hub"
-
-
- defaultValue stringRequired
Can be one of: "analytics-hub"
-
default
Error response.
- application/json object
application/json properties
- errors array of objects
errors properties
- code integer
Error code.
- title string
Error cause.
-
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.tenantSettings.getStartPages()qlik tenant-settings start-page lscurl "https://{tenant}.{region}.qlikcloud.com/api/v1/tenant-settings/start-pages" \-H "Authorization: Bearer <access_token>"Example Response
{ "values": [ { "route": "/insights", "value": "analytics-hub" } ], "defaultValue": "analytics-hub"}