Qlik Sense
API integration

list_all_qlik_sense_licenses

Gets the general information of the license applied to the current tenant.

list_all_qlik_sense_roles

List roles. Returns a list of roles using cursor-based pagination. Results are paginated with limit; Truto follows the next link.

get_single_qlik_sense_role_by_id

Get role by ID. Returns the requested role. Required: id.

create_a_qlik_sense_role

Create role. Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the TenantAdmin role. Required: name.

delete_a_qlik_sense_role_by_id

Delete role by ID. Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type custom. Requestor must be assigned the TenantAdmin role. Only custom roles can be deleted. The id is the id. Required: id.

update_a_qlik_sense_role_by_id

Update role by ID. Updates the requested role. Only applicable to roles of type custom. Requestor must be assigned the TenantAdmin role. The id is the id. Required: id.

list_all_qlik_sense_me

Get my user. Redirects to retrieve the user resource associated with the JWT claims.

list_all_qlik_sense_users

List users. Returns a list of users using cursor-based pagination. Results are paginated with limit; Truto follows the next link.

get_single_qlik_sense_user_by_id

Get user by ID. Returns the requested user. Required: id.

delete_a_qlik_sense_user_by_id

Delete user by ID. Deletes the requested user. Required: id. This permanently deletes the user from the tenant.

update_a_qlik_sense_user_by_id

Update user by ID. Updates fields for a user resource. Required: id.

create_a_qlik_sense_user

Create user. Creates an invited user. Required: subject.

qlik_sense_users_search

Filter users. Retrieves a list of users matching the filter using an advanced query string.

list_all_qlik_sense_groups

List groups. Returns a list of groups with cursor-based pagination. Results are paginated with limit; Truto follows the next link.

get_single_qlik_sense_group_by_id

Get group by ID. Returns the requested group. Required: id.

create_a_qlik_sense_group

Create group. Creates a new group. The maximum number of groups a tenant can have is 10,000. Group names are case-sensitive, and must be unique. Required: name.

delete_a_qlik_sense_group_by_id

Delete group by ID. Deletes the requested group. Permanently deletes the group. The id is the groupId. Required: id.

qlik_sense_groups_search

Filter groups. Retrieves a list of groups matching the filter using advanced query string.

update_a_qlik_sense_group_by_id

Update group by ID. Updates the requested group. The id is the groupId. Required: id.

qlik_sense_group_settings_bulk_update

Update group settings. Updates the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups. Updates the tenant-wide group settings (not a single group).

list_all_qlik_sense_group_settings

Get group settings. Returns the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.

qlik_sense_license_assignments_bulk_delete

Removes license access for the given users. Removes license assignments from the listed users. Required: delete.

qlik_sense_license_assignments_bulk_update

Updates license access for the given users. Required: update.

create_a_qlik_sense_license_assignment

Assigns license access to the given users. Required: add.

list_all_qlik_sense_license_assignments

Retrieves assignments for the current tenant. Paginated with limit; Truto follows the next link.

list_all_qlik_sense_license_consumption

Retrieves license consumption for the current tenant. Paginated with limit; Truto follows the next link.

qlik_sense_license_settings_bulk_update

Set auto assign settings for tenant. Replaces the tenant-wide license settings.

list_all_qlik_sense_license_settings

Get auto assign settings for tenant.

list_all_qlik_sense_license_status

Gets the license status information of the current tenant.

list_all_qlik_sense_user_counts

Count users. Returns the number of users in a given tenant.

create_a_qlik_sense_user_invite

Invite one or more users by email address.

qlik_sense_access_agent_file_allowed_paths_bulk_update

Set file connector allowed paths configuration. Completely replaces the contents of the allowed paths configuration file for the File Connector. Partial updates are not supported. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.6+. Required: agent_id.

list_all_qlik_sense_access_agent_file_allowed_paths

Get file connector allowed paths configuration. Retrieves the allowed paths settings for the File Connector. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.6+. Required: agent_id.

qlik_sense_access_agent_metrics_collector_config_bulk_update

Set metrics collector settings. Completely replaces the contents of the metrics collector settings configuration file. Partial updates are not supported. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.9+. Required: agent_id, connectorConfigurations, metricsCollectorSettings.

list_all_qlik_sense_access_agent_metrics_collector_config

Get metrics collector settings. Retrieves the settings for the metrics collector. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.9+. Required: agent_id.

qlik_sense_access_agent_odbc_type_mappings_bulk_update

Set connector type mapping configuration. Completely replaces the contents of the custom data type mapping configuration file for the Generic ODBC connector. Partial updates are not supported. There are property naming differences between the API and the file contents. Required: agent_id.

list_all_qlik_sense_access_agent_odbc_type_mappings

Get connector type mapping configuration. Retrieves the custom data type mapping settings for the Generic ODBC Connector. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.5+. Required: agent_id.

get_single_qlik_sense_api_keys_config_by_id

Get API key configuration. Retrieves the API key configuration for a tenant. The id is the tenantId. Required: id.

update_a_qlik_sense_api_keys_config_by_id

Update API keys configuration. Updates the API keys configuration for a given tenant ID. The id is the tenantId. Required: id.

create_a_qlik_sense_api_key

Create API key. Creates an API key, either for a user, or for configuring SCIM for a compatible Identity Provider. Sending sub and subType is required only for creating SCIM keys. Required: description.

delete_a_qlik_sense_api_key_by_id

Delete or revoke an API key. Deletes or revokes an API key for a given API key ID. When the owner of the API key sends the request, the key will be deleted and removed from the tenant. The id is the id. Required: id.

get_single_qlik_sense_api_key_by_id

Get API key for a given ID. Returns the API key for a given API key ID. The id is the id. Required: id.

list_all_qlik_sense_api_keys

Lists API keys for the tenant. To list API keys owned by other users, requesting user must be assigned the TenantAdmin role. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_api_key_by_id

Update API key description. Updates an API key description for a given API key ID. The id is the id. Required: id.

create_a_qlik_sense_apps_copy

Copies a specific app. Required: app_id.

list_all_qlik_sense_apps_data_lineage

Retrieves the lineage for an app. Returns a JSON-formatted array of strings describing the lineage of the app. Required: app_id.

list_all_qlik_sense_apps_data_metadata

Retrieves the data model and reload statistics metadata of an app. An empty metadata structure is returned if the metadata is not available in the app. Required: app_id.

create_a_qlik_sense_apps_export

Exports a specific app. Required: app_id.

create_a_qlik_sense_apps_import

Imports an app into the system. Required: file.

list_all_qlik_sense_apps_insight_analyses_model

Returns information about model used to make analysis recommendations. Lists all fields and master items in the logical model, along with an indication of the validity of the logical model if the default is not used. Required: app_id.

list_all_qlik_sense_apps_insight_analyses

Returns information about supported analyses for the app's data model. Lists available analysis types, along with minimum and maximum number of dimensions, measures, and fields. Required: app_id.

qlik_sense_apps_insight_analyses_recommend

Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis. Required: app_id.

delete_a_qlik_sense_apps_media_file_by_id

Deletes a media content file or complete directory. Returns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure or lack of permission. The id is the path. Required: id, app_id.

get_single_qlik_sense_apps_media_file_by_id

Gets media content from file. Returns a stream of bytes containing the media file content on success, or error if file is not found. The id is the path. Required: id, app_id.

update_a_qlik_sense_apps_media_file_by_id

Stores the media content file. Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path. The id is the path. Required: id, app_id, file.

get_single_qlik_sense_apps_media_list_by_id

Lists media content. Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found. The id is the path. Required: id, app_id.

list_all_qlik_sense_apps_media_thumbnail

Gets media content from file currently used as application thumbnail. Returns a stream of bytes containing the media file content on success, or error if file is not found. The image selected as thumbnail is only updated when application is saved. Required: app_id.

qlik_sense_apps_objects_change_owner

Sets owner on an app object. The user must be the owner of the object. Required: app_id, object_id.

qlik_sense_apps_owner_bulk_update

Changes owner of the app. Required: app_id.

qlik_sense_apps_placement_bulk_delete

Removes the app size override for an app. Required: app_id.

qlik_sense_apps_placement_bulk_update

Sets the app size override for an app. Required: app_id.

list_all_qlik_sense_apps_placement

Retrieves the app size override for an app. Required: app_id.

list_all_qlik_sense_apps_privileges

Gets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.

qlik_sense_apps_publish_bulk_update

Republishes a published app to a managed space. Required: app_id.

create_a_qlik_sense_apps_publish

Publishes a specific app to a managed space. Required: app_id.

get_single_qlik_sense_apps_reloads_log_by_id

Retrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8". The id is the reloadId. Required: id, app_id.

list_all_qlik_sense_apps_reloads_logs

Retrieves the metadata about all script logs stored for an app. Returns an array of ScriptLogMeta objects. Required: app_id.

get_single_qlik_sense_apps_reloads_metadatum_by_id

Retrieves the app reload metadata list. Reload metadata contains reload information, including reload id, duration, endtime and lineage load info. Data is available for the last 10 reloads of an application. The id is the reloadId. Required: id, app_id.

qlik_sense_apps_report_filters_count

Get the number of filters for the given app and filter types. Required: app_id, filterTypes.

create_a_qlik_sense_apps_report_filter

Create a new filter. Creates a new report filter which is used to re-apply selections, variables, patches to an engine session. Required: app_id, name, filterType, filterVersion.

delete_a_qlik_sense_apps_report_filter_by_id

Delete a filter. The id is the id. Required: id, app_id.

get_single_qlik_sense_apps_report_filter_by_id

Get a filter. The id is the id. Required: id, app_id.

list_all_qlik_sense_apps_report_filters

Get the filter list. List all filters that are present in the given app. Filters allow to reduce the app data visible in a report output. Each filter can contain definitions on one or multiple fields. Required: app_id, filterTypes. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_apps_report_filter_by_id

Update a filter. The id is the id. Required: id, app_id.

create_a_qlik_sense_apps_script

Sets script for an app. Required: app_id.

delete_a_qlik_sense_apps_script_by_id

Deletes a specific version of the script for an app. Fails if the supplied id is the current version. The id is the id. Required: id, app_id.

get_single_qlik_sense_apps_script_by_id

Retrieves a version of the script for an app. Returns the script text. The id is the id. Required: id, app_id.

list_all_qlik_sense_apps_scripts

Retrieves the script history for an app. Returns information about the saved versions of the script in a list sorted with latest first. Required: app_id. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_apps_script_by_id

Updates a specific version of the script for an app. The id is the id. Required: id, app_id.

qlik_sense_apps_space_bulk_delete

Removes space from a specific app. Required: app_id.

qlik_sense_apps_space_bulk_update

Sets space on a specific app. Required: app_id.

create_a_qlik_sense_apps_validatescript

Validates the script.

create_a_qlik_sense_app

Creates a new app.

delete_a_qlik_sense_app_by_id

Deletes a specific app. The id is the appId. Required: id.

get_single_qlik_sense_app_by_id

Retrieves information for a specific app. The id is the appId. Required: id.

update_a_qlik_sense_app_by_id

Updates the information for a specific app. The id is the appId. Required: id.

list_all_qlik_sense_assistants_feedback

Get feedback. Retrieves feedback summary for the assistant. Required: assistant_id.

create_a_qlik_sense_assistants_sources_plaintext

Bulk search source chunks. Perform a bulk search for the plaintext of source chunks for the assistant. Required: assistant_id, chunkIds.

delete_a_qlik_sense_assistants_starters_followup_by_id

Delete a Followup. Deletes the specified Followup. The id is the followupId. Required: id, assistant_id, starter_id.

update_a_qlik_sense_assistants_starters_followup_by_id

Update a Followup. Updates the specified Followup. The id is the followupId. Required: id, assistant_id, starter_id, question, followups, recommendedAnswer, additionalContext.

create_a_qlik_sense_assistants_starter

Create a starter. Creates a new starter for the assistant. Required: assistant_id, question.

delete_a_qlik_sense_assistants_starter_by_id

Delete a starter. Deletes the starter and all of its resources. The id is the starterId. Required: id, assistant_id.

get_single_qlik_sense_assistants_starter_by_id

Get a starter. Retrieves the specified starter. The id is the starterId. Required: id, assistant_id.

list_all_qlik_sense_assistants_starters

List starters. Retrieves the list of starters for the assistant. Required: assistant_id. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_assistants_starter_by_id

Update a starter. Updates the specified starter. The id is the starterId. Required: id, assistant_id, question, createdAt, updatedAt, additionalContext, recommendedAnswer.

create_a_qlik_sense_assistants_threads_interactions_feedback

Create feedback. Creates feedback for the thread. Required: assistant_id, interaction_id, thread_id, vote, reason.

update_assistants_threads_interactions_feedback_by_id

Update feedback. Updates feedback for the thread. The id is the feedbackId. Required: id, assistant_id, interaction_id, thread_id.

create_a_qlik_sense_assistants_threads_interactions_review

Create feedback review. Creates feedback review for the thread. Required: assistant_id, interaction_id, thread_id, reviewStatus.

create_a_qlik_sense_assistants_threads_interaction

Create an interaction. Creates a new interaction for the thread. Required: assistant_id, thread_id, request, response, sources.

delete_a_qlik_sense_assistants_threads_interaction_by_id

Delete an interaction. Deletes the specified interaction and all of its resources. The id is the interactionId. Required: id, assistant_id, thread_id.

get_single_qlik_sense_assistants_threads_interaction_by_id

Get an interaction. Retrieves an interaction for the thread. The id is the interactionId. Required: id, assistant_id, thread_id.

list_all_qlik_sense_assistants_threads_interactions

List interactions. Retrieves the list of interactions for the thread. Required: assistant_id, thread_id. Paginated with limit; Truto follows the next link.

create_a_qlik_sense_assistants_thread

Create a thread. Creates a new thread for the assistant. Required: assistant_id, name.

delete_a_qlik_sense_assistants_thread_by_id

Delete a thread. Deletes the specified thread and all of its resources. The id is the threadid. Required: id, assistantid.

get_single_qlik_sense_assistants_thread_by_id

Get a thread. Retrieves a thread for the assistant. The id is the threadid. Required: id, assistantid.

qlik_sense_assistants_threads_invoke

Execute synchronous prompt. Execute prompt in synchronous non-streaming mode. Required: assistant_id, thread_id.

list_all_qlik_sense_assistants_threads

List threads. Retrieves the list of threads for the assistant. Required: assistant_id. Paginated with limit; Truto follows the next link.

qlik_sense_assistants_threads_stream

Execute asynchronous prompt. Execute prompt in asynchronous streaming mode. Required: assistant_id, thread_id.

update_a_qlik_sense_assistants_thread_by_id

Update thread properties. Updates the properties of an existing thread with JSON Patch-formatted data. The id is the threadid. Required: id, assistantid.

create_a_qlik_sense_assistant

Create an assistant. Creates a new assistant. Required: name, title, description, tags, spaceId, knowledgeBases, welcomeMessage, customProperties.

delete_a_qlik_sense_assistant_by_id

Delete an assistant. Deletes the assistant and all of its resources. The id is the id. Required: id.

get_single_qlik_sense_assistant_by_id

Get an assistant. Retrieves the specified assistant. The id is the id. Required: id.

list_all_qlik_sense_assistants

List assistants. Retrieves the list of assistants. The result can be filtered, sorted, and paginated. Paginated with limit; Truto follows the next link.

qlik_sense_assistants_search

Perform search on an assistant. Perform search with either SIMPLE or FULL mode. SIMPLE does semantic search while FULL does semantic search, reranking and hybrid search. Use topN to control number of chunks in response, max limit is 50. Default to 5. Required: assistant_id, prompt.

update_a_qlik_sense_assistant_by_id

Update assistant properties. Updates the properties of an existing assistant with JSON Patch-formatted data. The id is the id. Required: id.

list_all_qlik_sense_audits_archive

List archived audit events. Retrieves audit events from long-term storage. Returns all archived audit events for the specified date and tenant, formatted as a JSON array. Archived events are retained for the full lifetime of the tenant, and are not removed or size-limited. Required: date.

list_all_qlik_sense_audits_settings

Get server configuration options. Returns the server configuration options. It includes options that represent the server configuration state and parameters that were used to run the server with certain functionality.

list_all_qlik_sense_audits_sources

List possible event sources. Finds and returns the list of possible event sources for this tenant.

list_all_qlik_sense_audits_types

List possible event types. Finds and returns the list of possible event types for this tenant.

qlik_sense_audits_fetch_consumption_app

Export consumption app. Returns a Qlik Sense application (QVF file) containing usage data for the tenant's subscription. Requesting user must be assigned the TenantAdmin role. Available only for Capacity subscriptions. Consumption report is updated once per day.

get_single_qlik_sense_audit_by_id

Get a specific audit event. Finds and returns a specific audit events for the given event ID. The id is the id. Required: id.

list_all_qlik_sense_audits

List recent audit events. Retrieves list of events for subscribed services for your tenant. Stores events for 90 days, after which they can be accessed via /v1/audits/archive. Paginated with limit; Truto follows the next link.

qlik_sense_automation_connections_change_owner

Change automation connection owner. Changes the owner of an automation connection by specifying a new owner. Required: automation_connection_id.

qlik_sense_automation_connections_change_space

Change automation connection space. Changes the space of an automation connection by specifying a new space. Required: automation_connection_id.

qlik_sense_automation_connections_check

Check automation connection. Tries to validate and checks the connection status of an automation connection. Required: automation_connection_id.

create_a_qlik_sense_automation_connection

Create an automation connection. Creates a new connection object from an automation connector. Required: connectorId.

delete_a_qlik_sense_automation_connection_by_id

Delete an automation connection. Deletes the specified automation connection. The id is the id. Required: id.

get_single_qlik_sense_automation_connection_by_id

Get an automation connection. Returns details about the specified automation connection. The id is the id. Required: id.

list_all_qlik_sense_automation_connections

List automation connections. Retrieves a list of automation connections the requesting user has access to. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_automation_connection_by_id

Update an automation connection. Updates the specified properties of an automation connection. The id is the id. Required: id.

list_all_qlik_sense_automation_connectors

List automation connectors. Retrieves a list of automation connectors. Paginated with limit; Truto follows the next link.

create_a_qlik_sense_automations_run

Run an automation. Creates a run for a specific automation. Required: automation_id, context.

qlik_sense_automations_runs_export

Export automation run log. Retrieves the URL for the debug log of a specific automation run. Required: automation_id, run_id.

get_single_qlik_sense_automations_run_by_id

Get an automation run. Retrieves a specific run for an automation. The id is the runId. Required: id, automation_id.

list_all_qlik_sense_automations_runs

List automation runs. Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the one of roles: TenantAdmin, AnalyticsAdmin. Required: automation_id. Paginated with limit; Truto follows the next link.

qlik_sense_automations_runs_retry

Retry an automation run. Retries a specific run by creating a new run using the same inputs. Required: automation_id, run_id.

qlik_sense_automations_runs_stop

Stop an automation run. Forcefully stops an automation run immediately. Required: automation_id, run_id.

list_all_qlik_sense_automations_usage

Get automation usage metrics. Retrieves paginated usage metrics for automations. The requesting user must be assigned the TenantAdmin or AnalyticsAdmin role. Required: filter.

qlik_sense_automations_change_owner

Change automation owner. Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. Required: automation_id, userId.

qlik_sense_automations_change_space

Change automation space. Changes the space of an automation by specifying a new space. Required: automation_id, spaceId.

qlik_sense_automations_copy

Duplicate an automation. Duplicates an existing automation. Required: automation_id, name.

create_a_qlik_sense_automation

Create an automation. Creates a new automation. The requesting user must be assigned the AutomationCreator role or have at least one of the following scopes: automations, admin.automations, automations.private or automations.shared.

delete_a_qlik_sense_automation_by_id

Delete an automation. Deletes an automation. The id is the id. Required: id.

qlik_sense_automations_disable

Disable an automation. Disables an automation so that it cannot be run. Required: automation_id.

qlik_sense_automations_enable

Enable an automation. Enables an automation so that it can be run. Required: automation_id.

get_single_qlik_sense_automation_by_id

Get an automation. Retrieves the full definition of an automation. The id is the id. Required: id.

list_all_qlik_sense_automations

List automations. Retrieves a list of the automations that the requesting user has access to. Paginated with limit; Truto follows the next link.

qlik_sense_automations_move

Change automation owner. Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. Required: automation_id, userId.

update_a_qlik_sense_automation_by_id

Update an automation. Updates the full definition of an automation. The id is the id. Required: id.

create_a_qlik_sense_automl_deployments_realtime_prediction

Generate predictions. Generates predictions in a synchronous request and response. Required: deployment_id.

list_all_qlik_sense_automl_predictions_coordinate_shap

Get shapley values in coordinate form. Returns a file containing the shapley values in coordinate form that are associated with a prediction ID. Required: prediction_id.

create_a_qlik_sense_automl_predictions_job

Retrieve jobs associated with a prediction. Retrieve jobs that are associated with a prediction. Job with correlation type prediction. Required: prediction_id.

list_all_qlik_sense_automl_predictions_not_predicted_reasons

Get any rows where a prediction was not produced. Returns a file containing any rows in a prediction operation where a prediction was unable to be produced. Required: prediction_id.

list_all_qlik_sense_automl_predictions_predictions

Get a file containing predicted values. Returns a file containing the predicted values that are associated with a prediction ID. Required: prediction_id.

list_all_qlik_sense_automl_predictions_shap

Return a file containing shapley values. Returns a file containing the shapley values that are associated with a prediction ID. Required: prediction_id.

list_all_qlik_sense_automl_predictions_source

Return a file containing source values. Returns a file containing the source values and an index field that are associated with a prediction ID. Required: prediction_id.

list_all_qlik_sense_banners

Get banner. Retrieves announcement banner configuration for the tenant, including content, scheduling, and link information for display at the top of the client interface.

qlik_sense_banners_upsert

Set banner. Sets content, scheduling, and optional action links for the tenant-wide announcement banner. Requires TenantAdmin role. Required: enabled, message, startTime, endTime, type, linkEnabled.

list_all_qlik_sense_brands_active

Retrieve active brand. Returns the current active brand. If using the Qlik default brand, no value is returned.

create_a_qlik_sense_brands_file

Creates a brand file for the specified identifier. Required: brand_id, brand_file_id.

delete_a_qlik_sense_brands_file_by_id

Delete a brand file. Deletes the specified brand file. The id is the brand-file-id. Required: id, brand_id.

get_single_qlik_sense_brands_file_by_id

Download brand file. Downloads the specified brand file. The id is the brand-file-id. Required: id, brand_id.

update_a_qlik_sense_brands_file_by_id

Update a brand file. Updates the specified brand file. The id is the brand-file-id. Required: id, brand_id.

qlik_sense_brands_activate

Activate a brand. Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken. Required: brand_id.

create_a_qlik_sense_brand

Create a new brand. Creates a new brand. Required: name.

qlik_sense_brands_deactivate

Deactivate a brand. Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken. Required: brand_id.

delete_a_qlik_sense_brand_by_id

Delete a brand. Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default. The id is the brand-id. Required: id.

get_single_qlik_sense_brand_by_id

Retrieve a brand. Returns a specific brand. The id is the brand-id. Required: id.

list_all_qlik_sense_brands

List brands. Lists all brand entries for a tenant. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_brand_by_id

Update a brand. Patches a brand. The id is the brand-id. Required: id.

list_all_qlik_sense_collections_favorites

Get user's favorites collection. Lists the user's favorites collection.

create_a_qlik_sense_collections_item

Add an item to a collection. Adds an item to a collection and returns the item. Required: collection_id, id.

delete_a_qlik_sense_collections_item_by_id

Remove an item. Removes an item from a collection. The id is the itemId. Required: id, collection_id.

get_single_qlik_sense_collections_item_by_id

Get an item. Finds and returns an item in a specific collection. See GET /items/{id}. The id is the itemId. Required: id, collection_id.

list_all_qlik_sense_collections_items

List items in a collection. Retrieves items from a collection that the user has access to. Required: collection_id. Paginated with limit; Truto follows the next link.

create_a_qlik_sense_collection

Create a new collection. Creates and returns a new collection. Collections of type public (shown as tags in the user interface) must have unique names. Other collection types can reuse names. Required: name, type.

delete_a_qlik_sense_collection_by_id

Delete a collection. Deletes a collection and removes all items from the collection. The id is the collectionId. Required: id.

get_single_qlik_sense_collection_by_id

Get a collection. Finds and returns a collection. The id is the collectionId. Required: id.

list_all_qlik_sense_collections

List collections. Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with /v1/collections/favorites. Paginated with limit; Truto follows the next link.

qlik_sense_collections_replace

Update a collection's name and description. Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value. Required: collection_id.

update_a_qlik_sense_collection_by_id

Update collection. Updates the name, description, or type fields provided in the patch body. Can be used to publish a private collection as a publicgoverned collection by patching /type with publicgoverned once the collection contains at least 1 item. The id is the collectionId. Required: id.

create_a_qlik_sense_conditions_evaluation

Executes the condition. Required: condition_id, causalEvent, contextId.

delete_a_qlik_sense_conditions_evaluation_by_id

Delete an Evaluation. The id is the evaluationId. Required: id, condition_id.

get_single_qlik_sense_conditions_evaluation_by_id

Get an Evaluation. The id is the evaluationId. Required: id, condition_id.

create_a_qlik_sense_conditions_preview

Create condition preview request\. Create condition preview request. Required: type.

get_single_qlik_sense_conditions_preview_by_id

Get condition preview response. The id is the id. Required: id.

qlik_sense_conditions_settings_bulk_update

Updates condition manager settings. Updates API configuration. Accessible only by tenant admins. Required: enable-conditions.

list_all_qlik_sense_conditions_settings

Retrieves condition manager settings. Lists api settings.

create_a_qlik_sense_condition

Creates a new condition. Required: type.

delete_a_qlik_sense_condition_by_id

Delete the condition. The id is the id. Required: id.

get_single_qlik_sense_condition_by_id

Retrieve a specific condition by id. The id is the id. Required: id.

update_a_qlik_sense_condition_by_id

Patch values in the condition. The id is the id. Required: id.

list_all_qlik_sense_consumption_executions

Retrieves the list of executions on an specific tenant. Lists of execution records by tenant. Paginated with limit; Truto follows the next link.

create_a_qlik_sense_csp_origin

Create a new CSP. Creates a new content security policy for an origin. Required: origin.

delete_a_qlik_sense_csp_origin_by_id

Delete a CSP. Deletes a specific content security policy. The id is the id. Required: id.

qlik_sense_csp_origins_generate_header

Retrieve CSP header. Retrieves the full content security policy header (including all configured policies and origins) for the tenant.

get_single_qlik_sense_csp_origin_by_id

Get a CSP. Returns details for a specific content security policy. The id is the id. Required: id.

list_all_qlik_sense_csp_origins

List CSPs. Retrieves all content security policies for a tenant. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_csp_origin_by_id

Update a CSP. Updates a content security policy. The id is the id. Required: id, origin.

list_all_qlik_sense_csrf_token

Get CSRF token. Returns CSRF token via the qlik-csrf-token header.

list_all_qlik_sense_data_alerts_condition

Get data alert task condition. Retrieves the condition associated with a data alerting task. Required: alert_id.

list_all_qlik_sense_data_alerts_executions_evaluations

Get data alert task execution evaluation. Retrieves the content of an evaluation for a specified data alerting task execution. Required: execution_id, task_id.

list_all_qlik_sense_data_alerts_executions_stats

Get data alert task execution stats. Retrieves stats for overall data alerting task executions. Required: task_id, period.

delete_a_qlik_sense_data_alerts_execution_by_id

Delete data alert task execution. Deletes a specific data alerting task execution. The id is the executionId. Required: id, alert_id.

get_single_qlik_sense_data_alerts_execution_by_id

Get data alert task execution. Retrieves a specific execution for the specified data alerting task. The id is the executionId. Required: id, alert_id.

list_all_qlik_sense_data_alerts_executions

List data alert task executions. Lists executions for the specified data alerting task. Required: task_id. Paginated with limit; Truto follows the next link.

list_all_qlik_sense_data_alerts_recipient_stats

Get data alert task recipient stats. Retrieve the recipient stats for a data alerting task. Required: alert_id.

qlik_sense_data_alerts_settings_bulk_update

Update data alert settings. Updates the settings for data alerts. User must be assigned the TenantAdmin role. Required: enable-data-alerting.

list_all_qlik_sense_data_alerts_settings

Get data alert settings. Retrieves the current settings for data alerts.

create_a_qlik_sense_data_alert

Create data alert task. Creates a new data alerting task. Required: appId, conditionId, name, recipients, triggerType.

delete_a_qlik_sense_data_alert_by_id

Delete data alert task. Deletes a specific data alerting task. The id is the alertId. Required: id.

get_single_qlik_sense_data_alert_by_id

Get data alert task. Returns the details of a specific data alert task. The id is the alertId. Required: id.

list_all_qlik_sense_data_alerts

List data alert tasks. Retrieves all data alert tasks accessible to the user. Users assigned the TenantAdmin or AnalyticsAdmin role can view all tasks. Paginated with limit; Truto follows the next link.

qlik_sense_data_alerts_trigger

Create data alert task trigger. Creates a new data alerting task trigger action. Required: alertingTaskID.

update_a_qlik_sense_data_alert_by_id

Update data alert task. Updates one or more properties of a specific data alerting task. The id is the alertId. Required: id.

qlik_sense_data_alerts_validate

Validate data alert task. Validates a new data alerting task. Current support includes validation for recipients only. Required: appId, conditionId, name, recipients, triggerType.

qlik_sense_data_assets_bulk_delete

Batch delete data assets by IDs.

create_a_qlik_sense_data_asset

Save new data asset. Required: appType, technicalName.

get_single_qlik_sense_data_asset_by_id

Get data asset by ID. The id is the data-asset-id. Required: id.

qlik_sense_data_assets_replace

Update data asset. Required: data_asset_id, appType, technicalName.

update_a_qlik_sense_data_asset_by_id

Patch data asset. The id is the data-asset-id. Required: id.

qlik_sense_data_connections_bulk_delete

Delete multiple connections, only available to Admin. Required: connections.

qlik_sense_data_connections_bulk_update

Update multiple connections, only available to Admin. When update is to change ownership of a connection, the credentials associated with the connection will NOT be transferred to the new owner, and new owner is expected to provide their own credentials for the connection. Required: connections.

create_a_qlik_sense_data_connection

Creates a new connection. Depending on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created. Required: datasourceID, qName.

delete_a_qlik_sense_data_connection_by_id

Deletes the specified data connection by ID (or by name when type=connectionname is set in query). The id is the qID. Required: id.

qlik_sense_data_connections_duplicate

Duplicate a connection. Required: id.

get_single_qlik_sense_data_connection_by_id

Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname.". The id is the qID. Required: id.

list_all_qlik_sense_data_connections

Gets a list of connections. Paginated with limit; Truto follows the next link.

qlik_sense_data_connections_replace

Updates a connection specified by connection ID (or by name when type=connectionname is set in query). Depends on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created. Required: q_id, qID, qName, qConnectStatement, qType, qEngineObjectID.

update_a_qlik_sense_data_connection_by_id

Patches a connection specified by connection ID (or by name when type=connectionname is set in query). The id is the qID. Required: id.

delete_a_qlik_sense_data_credential_by_id

Deletes the specified credential by ID (or by name when type=credentialname is set in query). The id is the qID. Required: id.

qlik_sense_data_credentials_filter_orphan

Gets list of orphan data credentials (i.e. credentials that are not associated to any data connection) filtering on properties defined in request body.

get_single_qlik_sense_data_credential_by_id

Gets a credential by ID (or by name when bycredentialname=true is set in query). The id is the qID. Required: id.

qlik_sense_data_credentials_replace

Updates a credential specified by ID (or by name when bycredentialname=true is set in query). Required: q_id, qName, qType, qUsername, qPassword.

update_a_qlik_sense_data_credential_by_id

Patches a credential specified by ID (or by name when bycredentialname=true is set in query). The id is the qID. Required: id.

get_single_qlik_sense_data_files_connection_by_id

Get the built-in connection used by the engine to load/write data files given a connection ID. The id is the id. Required: id.

list_all_qlik_sense_data_files_connections

Get the list of built-in connections used by the engine to load/write data files. The non-filtered list contains a set of hardcoded connections, along with one connection per team space that the given user has access to. Paginated with limit; Truto follows the next link.

list_all_qlik_sense_data_files_quotas

Get quota information for the calling user.

qlik_sense_data_files_bulk_change_space

Change the spaces that a set of existing data files or folders reside in a a single batch. This is to allow for a separate admin type of operation that is more global in terms of access in cases where admin users may not explicitly have been granted full access to a given space within the declared space-level permissions. Required: change-space.

qlik_sense_data_files_bulk_delete

Delete the specified set of data files and/or folders as a single batch. Required: delete.

qlik_sense_data_files_change_owner

Change the owner of an existing data file or folder. This is primarily an admin type of operation. In general, the owner of a data file or folder is implicitly set as part of a create or update operation. Required: data_file_id, ownerId.

qlik_sense_data_files_change_space

Change the space that an existing data file or folder resides in. This is to allow for a separate admin type of operation that is more global in terms of access in cases where admin users may not explicitly have been granted full access to a given space within the declared space-level permissions. Required: data_file_id.

create_a_qlik_sense_data_file

Upload a new data file or create a new folder.

delete_a_qlik_sense_data_file_by_id

Delete the specified data file or folder. Deleting a folder will also recursively delete all files and subfolders that reside within the specified folder. The id is the id. Required: id.

get_single_qlik_sense_data_file_by_id

Get descriptive info for the specified data file. The id is the id. Required: id.

list_all_qlik_sense_data_files

Get descriptive info for the specified data files. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_data_file_by_id

Re-upload an existing data file or update an existing folder. The id is the id. Required: id.

create_a_qlik_sense_data_qualities_computation

Trigger data quality computation. Triggers a full data quality computation for a dataset, running profile calculation followed by data quality assessment.

get_single_qlik_sense_data_qualities_computation_by_id

Get data quality computation status. Retrieves the current execution status of a data quality computation. Poll this endpoint after triggering a computation to determine when results are available. The id is the computationId. Required: id.

list_all_qlik_sense_data_qualities_global_results

Get global data quality. Retrieves the global quality results for a dataset, showing counts of valid, invalid, empty, and total sample cells. Required: datasetId.

list_all_qlik_sense_data_sets_profiles

Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed. Required: data_set_id. Paginated with limit; Truto follows the next link.

qlik_sense_data_sets_bulk_delete

Batch delete data sets.

create_a_qlik_sense_data_set

Save a new data set. Creates and saves a new data set in the catalog. Required: dataAssetInfo, qri, secureQri, technicalName.

get_single_qlik_sense_data_set_by_id

Get data set by ID. The id is the data-set-id. Required: id.

qlik_sense_data_sets_replace

Update data set. Fully replaces an existing DataSet by ID, including ownership attributes. A user can update any DataSet within a space if they fulfill one of the following conditions: - Has Can edit permission in a data space. Required: data_set_id, dataAssetInfo, qri, secureQri, technicalName.

update_a_qlik_sense_data_set_by_id

Patch data set. Partially updates an existing DataSet by ID using JSON Patch operations (RFC 6902), including ownership attributes. A user can update any DataSet within a space if they fulfill one of the following conditions: - Has Can edit permission in a data space. The id is the data-set-id. Required: id.

list_all_qlik_sense_data_sources_api_specs

Get 'connectionProperties' for a given datasource. Required: data_source_id.

list_all_qlik_sense_data_sources_gateways

Get list available gateway ID's for a given datasource. Required: data_source_id.

qlik_sense_data_sources_settings_bulk_update

Update data source settings. Updates the settings for a data source. Required: data_source_id, disabled.

list_all_qlik_sense_data_sources_settings

Get data source settings. Retrieves the settings for a data source. Required: data_source_id.

list_all_qlik_sense_data_sources

Get data sources. Gets the list of data sources available on the node.

qlik_sense_data_stores_data_assets_data_sets_bulk_delete

Delete data sets by data-store IDs and data-asset IDs. Required: data_asset_ids, data_store_ids.

list_all_qlik_sense_data_stores_data_assets_data_sets

Get all data sets belonging to the data store(s) and data asset(s). Required: data_asset_ids, data_store_ids. Paginated with limit; Truto follows the next link.

qlik_sense_data_stores_data_assets_bulk_delete

Delete data assets and child data-sets by data-store IDs. Required: data_store_ids.

list_all_qlik_sense_data_stores_data_assets

Get all data assets belonging to the data store(s). Required: data_store_ids. Paginated with limit; Truto follows the next link.

qlik_sense_data_stores_bulk_delete

Delete data stores if it does not contain any data-assets.

create_a_qlik_sense_data_store

Save new data store. Required: technicalName, type.

get_single_qlik_sense_data_store_by_id

Get data store by ID. The id is the data-store-id. Required: id.

list_all_qlik_sense_data_stores

Get all data stores. Paginated with limit; Truto follows the next link.

qlik_sense_data_stores_replace

Update data store. Required: data_store_id, technicalName, type.

update_a_qlik_sense_data_store_by_id

Patch data store. The id is the data-store-id. Required: id.

get_single_qlik_sense_di_projects_action_by_id

Get Action status. Retrieves the status of an asynchronous operation. The id is the actionId. Required: id.

qlik_sense_di_projects_bindings_bulk_update

Update project export variables. Updates the export variables for a specific data integration project. Required: project_id.

list_all_qlik_sense_di_projects_bindings

Get project export variables. Retrieves the export variables for a specific data integration project. Required: project_id.

list_all_di_projects_di_tasks_runtime_runs_state_datasets

List dataset run history states. Returns dataset-level state for a specific historical run instance of a data task. All datasets for the run are returned in a single response; this endpoint does not paginate. Required: data_task_id, project_id, run_id.

list_all_qlik_sense_di_projects_di_tasks_runtime_runs_state

Get task run history state. Returns the state of a specific historical run instance for a data task, including execution progress and any errors encountered. Required: data_task_id, project_id, run_id.

qlik_sense_di_projects_di_tasks_runtime_runs_search

Search task run history. Returns a paginated list of historical run instances for the specified data task, filtered by the provided criteria. Required: data_task_id, project_id.

list_all_qlik_sense_di_projects_di_tasks_runtime_state_datasets

List dataset runtime states. Returns dataset-level runtime state for a data task. Required: data_task_id, project_id.

list_all_qlik_sense_di_projects_di_tasks_runtime_state

Get project task runtime state. Get the current runtime state of a data task. Required: data_task_id, project_id.

qlik_sense_di_projects_di_tasks_runtime_start

Start a project task. Start a data task on a data integration project. Required: data_task_id, project_id.

qlik_sense_di_projects_di_tasks_runtime_stop

Stop a project task. Stop a data task on a data integration project. Required: data_task_id, project_id.

get_single_qlik_sense_di_projects_di_task_by_id

Get a project task. Get a specific data task within a project. The id is the dataTaskId. Required: id, project_id.

list_all_qlik_sense_di_projects_di_tasks

List project tasks. Lists data tasks within a given data integration project. Required: project_id.

qlik_sense_di_projects_di_tasks_prepare

Prepare a project task. Prepares the specified data task for execution. Required: data_task_id, project_id, allowRecreate.

qlik_sense_di_projects_di_tasks_recreate_datasets

Recreate task datasets. Recreates datasets in the specified data task. Required: data_task_id, project_id.

qlik_sense_di_projects_di_tasks_request_reload

Request dataset reload. Registers a request to reload the datasets associated with the specified data task. The reload does not occur immediately; it will take effect on the next scheduled or manual run of the task. Required: data_task_id, project_id.

qlik_sense_di_projects_di_tasks_validate

Validate a project task. Validates the specified data task. Required: data_task_id, project_id.

qlik_sense_di_projects_utils_validate_project_definitions

Validate project definitions. Validates the project definition files in a .zip and returns a structured report of warnings and errors. The validation runs synchronously and completes before the response is returned.

create_a_qlik_sense_di_project

Create a new project. Creates a new data integration project in the specified space.

qlik_sense_di_projects_export

Export a project. Exports the specified data integration project. Required: project_id.

get_single_qlik_sense_di_project_by_id

Get a project. Get a specific data integration project. The id is the projectId. Required: id.

qlik_sense_di_projects_import

Import a project (JSON zip). Imports a data integration project synchronously from a legacy JSON-based .zip file. This endpoint only accepts zips that contain JSON project files (the legacy format). The import is processed synchronously and completes before the response is returned. Required: project_id.

qlik_sense_di_projects_import_async

Import a project asynchronously. Imports a data integration project from a .zip file and returns an action identifier for tracking the background import operation. Required: project_id.

list_all_qlik_sense_di_projects

List projects. List data integration projects.

qlik_sense_di_projects_prepare

Prepare a project. Prepares the data integration project and its tasks for execution. Required: project_id.

qlik_sense_di_projects_validate

Validate project. Validates the data integration project and its tasks. Required: project_id.

create_a_qlik_sense_direct_access_agents_benchmarks_cancel

Request benchmark cancellation. Requests cancellation of a running benchmark for the specified agent. The request is asynchronous. Use the returned status URL to monitor when cancellation completes. Required: agent_id, benchmark_id.

create_a_qlik_sense_direct_access_agents_benchmark

Start an agent benchmark. Starts a background benchmark task that measures the throughput and latency of a Direct Access agent. Use the returned benchmarkId to monitor progress and retrieve performance metrics for capacity planning or performance optimization. Required: agent_id.

get_single_qlik_sense_direct_access_agents_benchmark_by_id

Get benchmark status. Retrieves the current status, progress, and performance metrics for a benchmark task. Use this operation to monitor a running benchmark or inspect its completed results. The id is the benchmarkId. Required: id, agent_id.

qlik_sense_direct_access_agents_configurations_bulk_update

Update agent configuration. Makes changes to the local agent configuration using JSON Patch. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Required: agent_id.

list_all_qlik_sense_direct_access_agents_configurations

Get agent configuration. Retrieves the connector agent configuration from the specified agent. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Required: agent_id.

get_single_qlik_sense_direct_access_agents_connectors_file_by_id

Get connector configuration. Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. The id is the fileType. Required: id, agent_id, connector_type.

list_all_qlik_sense_direct_access_agents_connectors_files

Get connector configuration files. Retrieves the configuration files associated with the connector. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Required: agent_id, connector_type.

update_a_qlik_sense_direct_access_agents_connectors_file_by_id

Set connector configuration. Completely replaces the contents of the connector's configuration file. Partial updates are not supported. The id is the fileType. Required: id, agent_id, connector_type.

qlik_sense_direct_access_agents_run_action

Restart an agent. Restarts the specified agent. If a reload is in RELOADING status the restart action will be ignored. Use force-restart to restart the agent even if a reload is in RELOADING status. Required: agent_action, agent_id.

qlik_sense_encryption_keyproviders_migration_details

Retrieve most recent migration details. Retrieve details for the ongoing or last completed migration for the tenant.

create_a_qlik_sense_encryption_keyprovider

Register a new multi-region AWS-KMS key. The AWS-KMS key configuration must match the Qlik Cloud region configuration requirements. Most regions should have a key deployed to the same AWS region as the Qlik Cloud tenant, with a replica key in the relevant Qlik Cloud DR region. Required: name, arn, keyprovider.

delete_a_qlik_sense_encryption_keyprovider_by_id

Deletes the given key from the tenant. Delete a key configuration from the tenant. Not supported for the default Qlik managed key provider. Key must not be in use. The id is the arnFingerPrint. Required: id.

get_single_qlik_sense_encryption_keyprovider_by_id

Retrieve key for a given ARN fingerprint. Retrieve key provider detail by passing the ARN fingerprint as parameter. The id is the arnFingerPrint. Required: id.

list_all_qlik_sense_encryption_keyproviders

List AWS key providers registered for the tenant. Returns a list of AWS key providers in the tenant. Use /actions/list to return all key providers.

qlik_sense_encryption_keyproviders_list_all

Lists all key providers registered for the tenant. Returns a list of all key providers in the tenant, including the default Qlik key provider.

qlik_sense_encryption_keyproviders_migrate

Migrate existing cipherkeys from current key provider to requested key provider. Migrate the active key from one provider to another. The migration process may take some time to complete, however this process will not impact users, and the tenant will continue to function normally during the migration. Required: arn_finger_print.

qlik_sense_encryption_keyproviders_reset_to_default_provider

Reset tenant key provider to default Qlik managed provider. Reset the encryption key back to the default Qlik managed provider. No action will be taken if tenant is already using the Qlik provider.

qlik_sense_encryption_keyproviders_test

Validate AWS-KMS key access. Validate a key to check if Qlik Cloud has required access to your AWS account and key policy, and the key configuration. If the key policy or configuration are changed from the required configuration, this may impact your ability to access your tenant. Required: arn_finger_print.

update_a_qlik_sense_encryption_keyprovider_by_id

Patches Name & Description of a given key provider. Update the name and/or description of a key provider. The id is the arnFingerPrint. Required: id.

get_single_qlik_sense_extensions_file_by_id

Download file from extension archive. Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension. The id is the filepath. Required: id, extension_id.

list_all_qlik_sense_extensions_file

Download extension as an archive. Downloads all files in the extension matching either extension ID or extension name as a .zip archive. Required: extension_id.

create_a_qlik_sense_extension

Create a new extension. Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.

delete_a_qlik_sense_extension_by_id

Delete a specific extension. Deletes a specific extension matching either extension ID or extension name. The id is the id. Required: id.

get_single_qlik_sense_extension_by_id

Get a specific extension. Returns a specific extension matching either extension ID or extension name. The id is the id. Required: id.

list_all_qlik_sense_extensions

List all extensions. Lists all imported extensions in the tenant.

update_a_qlik_sense_extension_by_id

Update a specific extension. Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object. The id is the id. Required: id.

create_a_qlik_sense_glossaries_category

Creates a new category. Required: glossary_id.

delete_a_qlik_sense_glossaries_category_by_id

Deletes a category. The id is the categoryId. Required: id, glossary_id.

get_single_qlik_sense_glossaries_category_by_id

Retrieves a category. The id is the categoryId. Required: id, glossary_id.

list_all_qlik_sense_glossaries_categories

Returns a list of categories for a glossary. Required: glossary_id. Paginated with limit; Truto follows the next link.

qlik_sense_glossaries_categories_replace

Updates a category. Required: category_id, glossary_id.

update_a_qlik_sense_glossaries_category_by_id

Updates category properties with json-patch formatted data. The id is the categoryId. Required: id, glossary_id.

create_a_qlik_sense_glossaries_terms_link

Creates a new link to a term. Links to resources are not considered term properties but external relations. Links can be created for terms in any status. Permissions on term and resource determine if the link can be created. Required: glossary_id, term_id, resourceType, resourceId.

list_all_qlik_sense_glossaries_terms_links

Returns a list of links assigned to a term. Required: glossary_id, term_id. Paginated with limit; Truto follows the next link.

list_all_qlik_sense_glossaries_terms_revisions

Retrieves previous revisions of a term. Required: glossary_id, term_id. Paginated with limit; Truto follows the next link.

qlik_sense_glossaries_terms_change_status

Changes the status of the term. Only a steward can verify a term. Once the term is verified only a steward can modify the term. Note that links to resources are considered external relations that can be managed independently of the status of the term. Required: glossary_id, term_id, status.

create_a_qlik_sense_glossaries_term

Creates a new term. Required: glossary_id, name.

delete_a_qlik_sense_glossaries_term_by_id

Deletes a term. The id is the termId. Required: id, glossary_id.

get_single_qlik_sense_glossaries_term_by_id

Retrieves a term. The id is the termId. Required: id, glossary_id.

list_all_qlik_sense_glossaries_terms

Returns a list of terms for a glossary. Required: glossary_id. Paginated with limit; Truto follows the next link.

qlik_sense_glossaries_terms_replace

Updates a term. Required: glossary_id, term_id, name.

update_a_qlik_sense_glossaries_term_by_id

Updates term properties with json-patch formatted data. The id is the termId. Required: id, glossary_id.

create_a_qlik_sense_glossary

Creates a new glossary. Only a steward can create a glossary. Required: name.

delete_a_qlik_sense_glossary_by_id

Deletes a glossary and all of its terms. The id is the id. Required: id.

qlik_sense_glossaries_export

Exports a glossary. Required: glossary_id.

get_single_qlik_sense_glossary_by_id

Retrieves a glossary. The id is the id. Required: id.

qlik_sense_glossaries_import

Imports a glossary from file. Creates a new or updates an existing glossary, including categories and terms, based on a glossary definition file. Supported formats are currently, qlik, atlan and atlas.

list_all_qlik_sense_glossaries

Returns all glossaries. Paginated with limit; Truto follows the next link.

qlik_sense_glossaries_replace

Updates a glossary. Required: glossary_id, name.

update_a_qlik_sense_glossary_by_id

Updates glossary properties with json-patch formatted data. The id is the id. Required: id.

list_all_qlik_sense_identity_provider_metadata

Return IdP configuration metadata. Returns IdP configuration metadata supported on the tenant. Clients can use this information to programmatically configure their interactions with Qlik Cloud.

list_all_qlik_sense_identity_providers_me_meta

Return active interactive IdP metadata. Retrieves default IdP metadata when no interactive IdP is enabled.

list_all_qlik_sense_identity_providers_status

List IdP statuses. Retrieves the status of all IdP configurations. Requires TenantAdmin role.

create_a_qlik_sense_identity_provider

Create a new IdP. Creates a new IdP on a tenant. Requesting user must be assigned the TenantAdmin role. For non-interactive IdPs (e.g. JWT), IdP must be created by sending options payload. For interactive IdPs (e.g. Required: protocol, provider.

delete_a_qlik_sense_identity_provider_by_id

Delete an IdP. Deletes an identity provider. Requesting user must be assigned the TenantAdmin role. The id is the id. Required: id.

get_single_qlik_sense_identity_provider_by_id

Get an IdP. Retrieves a specific IdP. Requesting user must be assigned the TenantAdmin role. The id is the id. Required: id.

list_all_qlik_sense_identity_providers

List IdPs. This endpoint retrieves any IdPs registered on the tenant. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_identity_provider_by_id

Update an IdP. Updates the configuration of an IdP. Requesting user must be assigned the TenantAdmin role. Partial failure is treated as complete failure and returns an error. The id is the id. Required: id.

list_all_qlik_sense_items_collections

List collections of an item. Finds and returns the collections (and tags) of an item. This endpoint does not return the user's favorites collection. Required: item_id. Paginated with limit; Truto follows the next link.

list_all_qlik_sense_items_publisheditems

List published items. Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item. Required: item_id. Paginated with limit; Truto follows the next link.

qlik_sense_items_settings_bulk_update

Update items settings. Updates the settings provided in the patch body. Currently used to enable or disable usage metrics in the tenant.

list_all_qlik_sense_items_settings

Get items settings. Finds and returns the items service settings for the current tenant. Currently used to enable or disable usage metrics in the tenant.

delete_a_qlik_sense_item_by_id

Delete an item. Deletes an item and removes the item from all collections. The id is the itemId. Required: id.

get_single_qlik_sense_item_by_id

Get an item. Finds and returns an item. The id is the itemId. Required: id.

list_all_qlik_sense_items

List items. Lists items that the user has access to. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_item_by_id

Update an item. Updates an item. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value. The id is the itemId. Required: id, resourceType.

get_single_qlik_sense_knowledgebases_datasources_history_by_id

Retrieve a knowledgebase datasource sync history. Retrieves detailed sync history for a specified datasource. The id is the syncId. Required: id, datasource_id, knowledgebase_id.

list_all_qlik_sense_knowledgebases_datasources_histories

List knowledgebase datasource sync histories. Retrieves sync history for a specified datasource in a knowledgebase. Returns a 404 if there is no sync history, or if the calling user doesn't have access to the datasource. Required: datasource_id, knowledgebase_id. Paginated with limit; Truto follows the next link.

qlik_sense_knowledgebases_datasources_schedules_bulk_delete

Delete knowledgebase datasource schedule. Deletes a datasource schedule. Required: datasource_id, knowledgebase_id.

create_a_qlik_sense_knowledgebases_datasources_schedule

Create a knowledgebase datasource schedule. Creates or updates a specified datasource schedule. Required: datasource_id, knowledgebase_id.

list_all_qlik_sense_knowledgebases_datasources_schedules

Get a knowledgebase datasource schedule. Returns a datasource schedule. Required: datasource_id, knowledgebase_id.

qlik_sense_knowledgebases_datasources_cancel

Cancel sync of a knowledgebase datasource. Cancels ongoing sync for a specified datasource. Required: datasource_id, knowledgebase_id.

create_a_qlik_sense_knowledgebases_datasource

Add a datasource to a knowledgebase. Adds a datasource to a knowledgebase. Required: knowledgebase_id, name, type.

delete_a_qlik_sense_knowledgebases_datasource_by_id

Delete a knowledgebase datasource. Deletes a specified datasource and all its resources. The id is the datasourceId. Required: id, knowledgebase_id.

qlik_sense_knowledgebases_datasources_download

Download knowledgebase datasource reference. Downloads a specified reference. Required: datasource_id, knowledgebase_id, path.

qlik_sense_knowledgebases_datasources_sync

Sync a knowledgebase datasource. Starts syncing a specified datasource to a specified knowledgebase index. Required: datasource_id, knowledgebase_id.

update_a_qlik_sense_knowledgebases_datasource_by_id

Update a knowledgebase datasource. Updates a specified datasource. The id is the datasourceId. Required: id, knowledgebase_id, type, contentSummary.

list_all_qlik_sense_knowledgebases_histories

Retrieve knowledgebase sync history. Retrieves sync history for the specified knowledgebase. Will return a 404 if no sync history exists, or if the calling user does not have access to synced datasources. Required: knowledgebase_id. Paginated with limit; Truto follows the next link.

create_a_qlik_sense_knowledgebase

Create new knowledgebase. Creates a new knowledgebase. Required: name, spaceId.

delete_a_qlik_sense_knowledgebase_by_id

Delete a knowledgebase. Deletes a knowledgebase and all of its resources. The id is the id. Required: id.

get_single_qlik_sense_knowledgebase_by_id

Retrieve a knowledgebase. Retrieves a specific knowledgebase. The id is the id. Required: id.

list_all_qlik_sense_knowledgebases

List knowledgebases. Returns a list of all knowledgebases the user has access to. Paginated with limit; Truto follows the next link.

qlik_sense_knowledgebases_search

Search chunks from a knowledge base. Execute search with either SIMPLE or FULL mode. SIMPLE does semantic search while FULL will also do reranking and include keyword based chunks. Use topN to control number of chunks in response, max limit is 50. Default to 5. Required: knowledgebase_id, prompt.

update_a_qlik_sense_knowledgebase_by_id

Update a knowledgebase. Updates properties of a specific knowledgebase. The id is the id. Required: id.

list_all_qlik_sense_lineage_graphs_impact_overview

Get all RESOURCE level nodes. Returns all RESOURCE level nodes that are impacted by a change in the source node. The number of tables and fields that are impacted for each resource are included as metadata. Required: impact_id.

list_all_qlik_sense_lineage_graphs_impact_source

Get impact sources. Returns all levels of the requested root node. Only node information will be returned. Required: impact_id.

qlik_sense_lineage_graphs_impact_expand

Get next-level nodes. Returns next-level nodes inside a specified node on an impact analysis graph retrieved using a base node. Required: impact_id, level, node.

qlik_sense_lineage_graphs_impact_search

Search all labels. Searchs all labels within a impact graph on all available levels. Returns result per level. Required: impact_id, filter.

create_a_qlik_sense_lineage_graphs_nodes_overview

Get lineage overview. Returns the first generation upstream direct lineage. For each field QRI, will find any direct linege dataset or application. Required: node_id.

qlik_sense_lineage_graphs_nodes_expand

Get expanded node and its edges. Returns the expanded node and its edges. Up and downstream nodes are not part of the response, edges are. The id is the root node that lineage is requested for. The QRI of the node to expand is sent as the query parameter "node" for expansion. Required: node_id, level, node.

get_single_qlik_sense_lineage_graphs_node_by_id

Get lineage graphs. Returns lineage graphs of a source node. The id (QRI) can point to an item on the field, table and resource level. The id is the id. Required: id.

qlik_sense_lineage_graphs_nodes_search

Search all labels. Returns result per level by searching all labels within a lineage graph on all available levels. Required: node_id, filter.

qlik_sense_ml_deployments_aliases_realtime_predictions_run

Generate predictions in a synchronous request/response. Required: deployment_id, alias_name.

create_a_qlik_sense_ml_deployments_alias

Create an alias. Creates an alias for a deployment. Required: deployment_id, data.

delete_a_qlik_sense_ml_deployments_alias_by_id

Delete an alias from a deployment. The id is the aliasId. Required: id, deployment_id.

get_single_qlik_sense_ml_deployments_alias_by_id

Get an alias. Retrieves an alias that exists on the deployment. The id is the aliasId. Required: id, deployment_id.

list_all_qlik_sense_ml_deployments_aliases

List aliases. Retrieves a list of aliases based on filter parameters for a deployment. Required: deployment_id. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_ml_deployments_alias_by_id

Update an alias. Updates an alias for a deployment. The id is the aliasId. Required: id, deployment_id.

qlik_sense_ml_deployments_batch_predictions_schedule_bulk_delete

Delete a batch prediction schedule. Deletes the schedule from a batch prediction. Required: deployment_id, batch_prediction_id.

ml_deployments_batch_predictions_schedule_bulk_replace

Add a batch prediction schedule. Adds a schedule to a batch prediction. Required: deployment_id, batch_prediction_id.

qlik_sense_ml_deployments_batch_predictions_schedule_bulk_update

Update a batch prediction schedule. Updates the schedule for a batch prediction. Required: deployment_id, batch_prediction_id.

list_all_qlik_sense_ml_deployments_batch_predictions_schedule

Get a batch prediction schedule. Retrieves the schedule for a batch prediction. Required: deployment_id, batch_prediction_id.

create_a_qlik_sense_ml_deployments_batch_prediction

Create a prediction configuration. Required: deployment_id.

delete_a_qlik_sense_ml_deployments_batch_prediction_by_id

Delete a batch prediction. The id is the batchPredictionId. Required: id, deployment_id.

get_single_qlik_sense_ml_deployments_batch_prediction_by_id

Retrieve a batch prediction. The id is the batchPredictionId. Required: id, deployment_id.

list_all_qlik_sense_ml_deployments_batch_predictions

List batch prediction configurations. Required: deployment_id. Paginated with limit; Truto follows the next link.

qlik_sense_ml_deployments_batch_predictions_predict

Run a batch prediction. Required: deployment_id, batch_prediction_id.

update_a_qlik_sense_ml_deployments_batch_prediction_by_id

Updates a batch prediction. The id is the batchPredictionId. Required: id, deployment_id.

qlik_sense_ml_deployments_models_add

Add deployed models for this deployment. Required: deployment_id, data.

qlik_sense_ml_deployments_models_remove

Remove deployed models from this deployment. Required: deployment_id, data.

qlik_sense_ml_deployments_realtime_predictions_run

Generate predictions in a synchronous request/response. Required: deployment_id.

qlik_sense_ml_deployments_activate_models

Activate deployment models. Activates the deployed model on this deployment. By default this is the model on the default alias; optionally pass modelId, aliasId or aliasName in the request body to target another model (precedence in that order, only one is used). Required: deployment_id.

create_a_qlik_sense_ml_deployment

Create a deployment.

qlik_sense_ml_deployments_deactivate_models

Deactivate deployment models. Deactivates the deployed model on this deployment. By default this is the model on the default alias; optionally pass modelId, aliasId or aliasName in the request body to target another model (precedence in that order, only one is used). Required: deployment_id.

delete_a_qlik_sense_ml_deployment_by_id

Delete a deployment. The id is the deploymentId. Required: id.

get_single_qlik_sense_ml_deployment_by_id

Get a deployment. The id is the deploymentId. Required: id.

list_all_qlik_sense_ml_deployments

List deployments. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_ml_deployment_by_id

Update a deployment. The id is the deploymentId. Required: id.

get_single_qlik_sense_ml_experiments_model_by_id

Get a model. The id is the modelId. Required: id, experiment_id.

list_all_qlik_sense_ml_experiments_models

List models. Required: experiment_id. Paginated with limit; Truto follows the next link.

create_a_qlik_sense_ml_experiments_version

Create an experiment version. Creates an experiment version. Poll this version and check its status field to determine when models are finished training. Required: experiment_id, data.

delete_a_qlik_sense_ml_experiments_version_by_id

Delete an experiment version. The id is the experimentVersionId. Required: id, experiment_id.

get_single_qlik_sense_ml_experiments_version_by_id

Get an experiment version. The id is the experimentVersionId. Required: id, experiment_id.

list_all_qlik_sense_ml_experiments_versions

List experiment versions. Required: experiment_id. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_ml_experiments_version_by_id

Update an experiment version. The id is the experimentVersionId. Required: id, experiment_id.

create_a_qlik_sense_ml_experiment

Create an experiment.

delete_a_qlik_sense_ml_experiment_by_id

Delete an experiment. The id is the experimentId. Required: id.

get_single_qlik_sense_ml_experiment_by_id

Get an experiment. The id is the experimentId. Required: id.

list_all_qlik_sense_ml_experiments

List experiments. Retrieves a list of experiments based on provided filter and sort parameters. Paginated with limit; Truto follows the next link.

qlik_sense_ml_experiments_recommend_models

Request model recommendations for an experiment. Returns model recommendations for a specified experiment, including the best-performing, fastest, and most accurate models based on evaluation metrics. Required: experiment_id.

update_a_qlik_sense_ml_experiment_by_id

Update an experiment. The id is the experimentId. Required: id.

qlik_sense_ml_jobs_cancel

Cancel jobs. Cancels jobs for an experiment version or batch prediction. Required: corr_type, corr_id.

create_a_qlik_sense_ml_profile_insight

Start profile insights creation. Starts creating profile insights for an experiment dataset. This is an asynchronous operation. A 202 Accepted response indicates that the process has started successfully. Use the link in the response to check the status.

get_single_qlik_sense_ml_profile_insight_by_id

Get profile insights. Retrieves profile insights for the specified dataset. If you received a 202 Accepted response from POST /ml/profile-insights, poll this endpoint until a 200 OK response with ready status is returned. The id is the dataSetId. Required: id.

qlik_sense_notes_settings_bulk_update

update the settings.

list_all_qlik_sense_notes_settings

Get the enablement status of the notes feature set for this tenant and user.

list_all_qlik_sense_notifications

List all supported notifications.

create_a_qlik_sense_oauth_clients_client_secret

Create an OAuth client secret. Create a new client secret for the specified OAuth client. An OAuth client can have a maximum of 5 client secrets at one time. Required: oauth_client_id.

delete_a_qlik_sense_oauth_clients_client_secret_by_id

Delete an OAuth client secret. Deletes a specific client secret for an OAuth client. The id is the hint. Required: id, oauth_client_id.

qlik_sense_oauth_clients_connection_configs_me_bulk_delete

Delete connection config for an OAuth client. Deletes the connection config for the calling tenant, related to the supplied client id. Required: oauth_client_id.

qlik_sense_oauth_clients_connection_configs_me_bulk_update

Update connection config for an OAuth client. Updates the consent method for the specified OAuth client. Required: oauth_client_id.

list_all_qlik_sense_oauth_clients_connection_configs_me

Get connection config for an OAuth client. Get configuration for consent method and status. Required: oauth_client_id.

create_a_qlik_sense_oauth_client

Create an OAuth client. Create a new OAuth client. Requires TenantAdmin role when created in-tenant. appType cannot be changed after creation. Consent method and published state can be changed after creation. Required: appType, clientName.

delete_a_qlik_sense_oauth_client_by_id

Delete an OAuth client. Delete the specified OAuth client. The id is the id. Required: id.

get_single_qlik_sense_oauth_client_by_id

Get an OAuth client. Retrieves the specified OAuth client. The id is the id. Required: id.

list_all_qlik_sense_oauth_clients

List OAuth clients. Retrieve all OAuth clients. Paginated with limit; Truto follows the next link.

qlik_sense_oauth_clients_publish

Publish an OAuth client. Publishes the specified OAuth client. By default, OAuth clients are bound to the tenant that created it. Publishing shares the client and makes it available to all other tenants within a region. Required: oauth_client_id.

update_a_qlik_sense_oauth_client_by_id

Update an OAuth client. Updates the specified OAuth client. Returns 202 Accepted with a client secret in the response body if a client secret is generated during the update (e.g., when adding client_secret to allowedAuthMethods). Otherwise returns 204 No Content. The id is the id. Required: id.

delete_a_qlik_sense_oauth_token_by_id

Revoke an OAuth token by ID. Revokes a specific OAuth token by ID. Requesting user must have TenantAdmin role assigned to delete tokens owned by other users. The id is the tokenId. Required: id.

list_all_qlik_sense_oauth_tokens

Retrieve list of OAuth tokens that the user has access to. Users assigned with a TenantAdmin role can list OAuth tokens generated for all users in the tenant. Paginated with limit; Truto follows the next link.

qlik_sense_questions_ask

Returns the generated response for parsed chat queries, if no app was specified nor present in conversation context, suggests matching apps. Required: text.

qlik_sense_questions_search

Returns NL metrics based on provided app IDs the user has access to. Required: filter.

get_single_qlik_sense_quota_by_id

Returns a specific quota item for the tenant (provided in JWT). The id is the id. Required: id.

list_all_qlik_sense_quotas

Returns all quota items for the tenant (provided in JWT).

create_a_qlik_sense_reload_task

Create a task. Creates a task for a specified app. Required: appId, timeZone.

delete_a_qlik_sense_reload_task_by_id

Delete a task. Deletes a task. The id is the taskId. Required: id.

get_single_qlik_sense_reload_task_by_id

Find a task. Finds and returns a task. The id is the taskId. Required: id.

list_all_qlik_sense_reload_tasks

Find and return tasks. Finds and returns the tasks that the user has access to. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_reload_task_by_id

Update an existing task. Updates an existing task. The id is the taskId. Required: id, appId, jobId, userId, tenantId, timeZone, state, links.

qlik_sense_reloads_cancel

Cancel a reload. Cancels a reload that is in progress or has been queued. Required: reload_id.

create_a_qlik_sense_reload

Reload an app. Reloads an app specified by an app ID. Required: appId.

get_single_qlik_sense_reload_by_id

Get reload record. Finds and returns a reload record. The id is the reloadId. Required: id.

list_all_qlik_sense_reloads

Find and return reloads. Finds and returns the reloads that the user has access to. Required: appId. Paginated with limit; Truto follows the next link.

create_a_qlik_sense_report_template

Create a new report template. Required: name, temporaryContentId.

delete_a_qlik_sense_report_template_by_id

Delete the specified report template. The id is the id. Required: id.

qlik_sense_report_templates_download

Download the template file of the specified report template. Required: report_template_id.

get_single_qlik_sense_report_template_by_id

Get descriptive info for the specified report template. The id is the id. Required: id.

list_all_qlik_sense_report_templates

Get descriptive info for the specified templates. Paginated with limit; Truto follows the next link.

qlik_sense_report_templates_replace

Update an existing report template. Required: report_template_id, name, temporaryContentId.

update_a_qlik_sense_report_template_by_id

Patch an existing report template. The id is the id. Required: id.

list_all_qlik_sense_reports_outputs

Get report request outputs. Get the list of the outputs produced so far for the given report request. The outputs are generated asynchronously and are complete only when the status of the report request is 'done' or 'failed' or 'aborted'. Required: report_id. Paginated with limit; Truto follows the next link.

list_all_qlik_sense_reports_status

Get report request processing status. Required: report_id.

create_a_qlik_sense_report

Queue a new report request generation. Required: type, output.

get_single_qlik_sense_sharing_tasks_executions_file_by_id

Get sharing task execution file. Retrieves the file content for the requested execution and file type. The id is the fileAlias. Required: id, execution_id, task_id.

get_single_qlik_sense_sharing_tasks_execution_by_id

Get sharing task execution. Retrieves a specific sharing task execution. The id is the executionId. Required: id, task_id.

list_all_qlik_sense_sharing_tasks_executions

List sharing task executions. Lists executions for the specified sharing task. Required: task_id. Paginated with limit; Truto follows the next link.

qlik_sense_sharing_tasks_settings_bulk_replace

Update sharing settings. Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the TenantAdmin role. Required: enable-sharing.

qlik_sense_sharing_tasks_settings_bulk_update

Update sharing toggle settings. Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the TenantAdmin role.

list_all_qlik_sense_sharing_tasks_settings

Get sharing settings. Retrieves the current settings for sharing tasks, reports, and other related configuration.

qlik_sense_sharing_tasks_cancel

Cancel sharing task execution. Requests cancellation of an execution of the specified recurring sharing task. Required: task_id.

create_a_qlik_sense_sharing_task

Create sharing task. Creates a new recurring sharing task. Required: name, state, templates, type.

delete_a_qlik_sense_sharing_task_by_id

Delete sharing task. Deletes a specific sharing task. The id is the taskId. Required: id.

qlik_sense_sharing_tasks_execute

Start sharing task execution. Requests execution of the specified recurring sharing task. Required: sharingTaskID.

get_single_qlik_sense_sharing_task_by_id

Get sharing task. Returns the details of a specific sharing task. The id is the taskId. Required: id.

list_all_qlik_sense_sharing_tasks

List sharing tasks. Retrieves all sharing tasks accessible to the user. Users assigned the TenantAdmin or AnalyticsAdmin role can view all tasks. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_sharing_task_by_id

Update sharing task. Updates one or more properties of a specific sharing task. The id is the taskId. Required: id.

create_a_qlik_sense_spaces_assignment

Assign a user or group to a space. Creates an assignment for a user or group (assignee) to a space with the specified roles. Assignments are not required for space owners, who receive all assignableRoles by default. Only one assignment can exist per space, per user or group. Required: space_id, type, assigneeId, roles.

delete_a_qlik_sense_spaces_assignment_by_id

Delete an assignment. Deletes an assignment. The id is the assignmentId. Required: id, space_id.

get_single_qlik_sense_spaces_assignment_by_id

Retrieve an assignment for a space. Retrieves a single assignment by assignment ID. Use GET /spaces/{spaceId}/assignments to list all users and groups assigned to the space and their assignment ID. The id is the assignmentId. Required: id, space_id.

list_all_qlik_sense_spaces_assignments

List assignments for a space. Retrieves the assignments of the space matching the query. Each assignment represents one user or group and their corresponding roles in the space. Assignments are not shown for the owner of a space, who receive all assignableRoles by default. Required: space_id. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_spaces_assignment_by_id

Update an assignment for a space. Updates a single assignment by assignment ID. Use GET /spaces/{spaceId}/assignments to list all users and groups assigned to the space and their assignment ID. The complete list of roles must be provided. The id is the assignmentId. Required: id, space_id.

create_a_qlik_sense_spaces_share

Create a space share. Creates a share. Required: space_id, type, assigneeId, roles, resourceType, resourceId.

delete_a_qlik_sense_spaces_share_by_id

Delete a space share. Deletes a space share. The id is the shareId. Required: id, space_id.

get_single_qlik_sense_spaces_share_by_id

Retrieve a space share. Retrieves a single space share by ID. The id is the shareId. Required: id, space_id.

list_all_qlik_sense_spaces_shares

List space shares. Retrieves the shares of the space matching the query. Required: space_id. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_spaces_share_by_id

Update a space share. Updates properties of a space share (roles, and disabled state for link shares). The id is the shareId. Required: id, space_id.

list_all_qlik_sense_spaces_types

List space types. Gets a list of distinct space types available for use in the tenant.

create_a_qlik_sense_space

Create a space. Creates a space. Spaces names must be unique. Spaces of type data should only be used for Qlik Talend Data Integration projects. Required: name, type.

delete_a_qlik_sense_space_by_id

Delete a space. Deletes a space. Ensure that you first delete all resources from the space to avoid orphaning content. When non-empty-space deletion protection is enabled for the tenant, deletion is rejected if Collections contains any items in the space. The id is the spaceId. Required: id.

get_single_qlik_sense_space_by_id

Retrieve a space. Retrieves a single space by ID. The id is the spaceId. Required: id.

list_all_qlik_sense_spaces

List spaces. Retrieves spaces that the current user has access to and match the query. Paginated with limit; Truto follows the next link.

qlik_sense_spaces_replace

Update a space. Updates a space. To update specific properties, use PATCH /spaces/{spaceId}. Required: space_id.

update_a_qlik_sense_space_by_id

Update a space's properties. Updates one or more properties of a space. To update all properties at once, use PUT /spaces/{spaceId}. The id is the spaceId. Required: id.

list_all_qlik_sense_tasks_resources_runs

List task runs for a resource. Returns a list of task runs for a specified resourceId. Required: resource_id. Paginated with limit; Truto follows the next link.

list_all_qlik_sense_tasks_runs_last

Get last task run. Returns the last run of a specific task. Required: task_id.

list_all_qlik_sense_tasks_runs_log

Get task run log. Get specific run log of a task. Required: task_id, run_id.

list_all_qlik_sense_tasks_runs

List task runs. Returns runs for the specified task. Required: task_id. Paginated with limit; Truto follows the next link.

create_a_qlik_sense_task

Create a task. Creates a new task. Required: name, specVersion.

delete_a_qlik_sense_task_by_id

Delete a task. Deletes a specific task. The id is the id. Required: id.

get_single_qlik_sense_task_by_id

Get a task. Retrieves details for a specific task. The id is the id. Required: id.

list_all_qlik_sense_tasks

List tasks. Retrieves a list of the tasks that the requesting user has access to. Paginated with limit; Truto follows the next link.

qlik_sense_tasks_start

Start a task. Starts the specified task. Required: task_id.

update_a_qlik_sense_task_by_id

Update a task. Updates a specific task. If the task is owned by another user, ownership will be transferred to the requesting user. The id is the id. Required: id, name, specVersion.

list_all_qlik_sense_temp_contents_details

Retrieve file details. Retrieve a summary of the metadata associated with a temporary content resource. It returns a 200 OK with a model if the temporary resource is valid. It returns a 410 Gone if the file has expired and 404 Not Found if the criteria is not met. Required: temp_content_id.

create_a_qlik_sense_temp_contents_file

Create a new upload resource (tus). Create a new upload resource (tus protocol creation extension POST request). See tus.io for details.

update_a_qlik_sense_temp_contents_file_by_id

Apply bytes at a given offset (tus). Apply bytes contained in the message at a given offset (tus protocol PATCH request). Note that the tus server only accepts that the Content-Type response header is set to application/offset+octet-stream. See tus.io for details. The id is the id. Required: id, file.

create_a_qlik_sense_temp_content

Upload a file as a temporary content resource. It returns a 201 Created with a location header that contains the location of the created resource. If filename or TTL is not properly set, a 400 Bad request is returned. Required: file.

get_single_qlik_sense_temp_content_by_id

Download a file. This endpoint is used to retrieve a temporary content file. It returns a valid (200 OK) in case the file exists and the user is authorized to view the contents. It returns a 410 Gone if the file has expired and 404 Not Found if the criteria is not met. The id is the id. Required: id.

list_all_qlik_sense_tenant_settings_start_pages

Get start pages. Retrieves start pages for the tenant settings.

qlik_sense_tenant_settings_bulk_delete

Delete tenant settings. Deletes the tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:delete.

qlik_sense_tenant_settings_bulk_update

Update tenant settings. Updates existing tenant settings. This is access controlled by the permission admin.tenant-settings:update.

create_a_qlik_sense_tenant_setting

Create tenant settings. 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.

list_all_qlik_sense_tenant_settings

Get tenant settings. Retrieves tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:read.

qlik_sense_tenant_settings_toggle_cross_region_data_processing

Toggle cross-region data processing. 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. Required: value.

qlik_sense_tenant_settings_toggle_cross_region_inference

Toggle cross-region inference. 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. Required: value.

list_all_qlik_sense_tenants_me

Redirect to current tenant. Redirects to current tenant.

create_a_qlik_sense_tenant

Create a tenant. Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the My Qlik portal to call this endpoint.

qlik_sense_tenants_deactivate

Deactivate a tenant. Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after estimatedPurgeDate. Tenant can be reactivated using /v1/tenants/{tenantId}/actions/reactivate until this date. Required: tenant_id, truto_confirm_hostname.

get_single_qlik_sense_tenant_by_id

Get a tenant. Retrieves a specific tenant by ID. The id is the tenantId. Required: id.

qlik_sense_tenants_reactivate

Reactivate a tenant. Reactivates a deactivated tenant. Tenants can be reactivated until the estimatedPurgeDate provided at time of deactivation. You must use a regional OAuth client generated via the My Qlik portal to call this endpoint. Required: tenant_id, truto_confirm_hostname.

update_a_qlik_sense_tenant_by_id

Update a tenant. Updates properties of a specific tenant by ID. The id is the tenantId. Required: id.

get_single_qlik_sense_themes_file_by_id

Download file from theme archive. Downloads a file from the theme matching either theme ID or theme name, identified by the file path within the imported extension. The id is the filepath. Required: id, theme_id.

list_all_qlik_sense_themes_file

Download theme as an archive. Downloads all files in the theme matching either theme ID or theme name as a .zip archive. Required: theme_id.

create_a_qlik_sense_theme

Create a new theme. Creates a new theme. Accepts either provided file or data object. The name of the new theme must be different to any existing themes.

delete_a_qlik_sense_theme_by_id

Delete specific theme. Deletes a specific theme matching either theme ID or theme name. The id is the id. Required: id.

get_single_qlik_sense_theme_by_id

Return specific theme. Returns a specific theme matching either theme ID or theme name. The id is the id. Required: id.

list_all_qlik_sense_themes

List all themes. Lists all imported themes in the tenant.

update_a_qlik_sense_theme_by_id

Update a specific theme. Updates a specific theme matching either theme ID or theme name. Accepts either provided file or data object. The id is the id. Required: id.

qlik_sense_transports_email_config_bulk_delete

Delete email configuration. Deletes the email configuration for the tenant.

qlik_sense_transports_email_config_bulk_replace

Update email configuration. Creates or replaces the email configuration for the tenant. Validation of the configuration is done as part of the request.

qlik_sense_transports_email_config_bulk_update

Patch email configuration. Patches the email configuration for the tenant. This endpoint is deprecated, use PUT /transports/email-config to replace the entire configuration instead.

list_all_qlik_sense_transports_email_config

Get email configuration. Returns the current email configuration and configuration status for the tenant.

qlik_sense_transports_email_config_send_test_email

Send test email. Attempts to sends a test email using the active configuration, with the supplied email info (subject, body, recipient).

qlik_sense_transports_email_config_validate

Get configuration status. Returns the current isValid value for the email configuration for the tenant. Does not attempt to connect to a server to verify the connection or send a test email. Will return false if no email configuration exists.

qlik_sense_transports_email_config_verify_connection

Verify configuration. Attempts to verify connection to email server using a low-level protocol handshake to confirm the server is reachable and the credentials are valid, without sending a test email.

qlik_sense_ui_config_pinned_links_bulk_create_pinned_links

Create multiple pinned links. Creates one or more pinned links for navigation, an alternative method to multiple calls to /ui-config/pinned-links. Links are displayed below any existing pinned links, and will be added in the order sent in the request. Required: scope, type, links.

create_a_qlik_sense_ui_config_pinned_link

Create pinned link. Creates a pinned link, which will appear below any existing pinned links in the tenant. Requires calling user to be assigned the TenantAdmin role. A tenant can have a maximum of 50 pinned links. Required: name, link, scope, type.

delete_a_qlik_sense_ui_config_pinned_link_by_id

Delete pinned link. Deletes a specific pinned link. Requires calling user to be assigned the TenantAdmin role. The id is the id. Required: id.

qlik_sense_ui_config_pinned_links_delete_all_pinned_links

Delete all pinned links. Deletes all pinned links in the tenant. Requires calling user to be assigned the TenantAdmin role.

get_single_qlik_sense_ui_config_pinned_link_by_id

Get pinned link. Retrieves a specific pinned link. The id is the id. Required: id.

list_all_qlik_sense_ui_config_pinned_links

Retrieves a list of all pinned links. All users can list pinned links. This endpoint does not support pagination as a tenant can have a maximum of 50 pinned links at one time.

update_a_qlik_sense_ui_config_pinned_link_by_id

Update pinned link. Updates a specific pinned link with an array of JSON patches. Requires calling user to be assigned the TenantAdmin role. The id is the id. Required: id.

create_a_qlik_sense_web_integration

Create web integration. Creates a web integration. Required: name.

delete_a_qlik_sense_web_integration_by_id

Delete web integration by ID. Deletes a single web integration by ID. The id is the id. Required: id.

get_single_qlik_sense_web_integration_by_id

Get web integration by ID. Retrieves a single web integration by ID. The id is the id. Required: id.

list_all_qlik_sense_web_integrations

List web integrations. Retrieves web integrations matching the query. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_web_integration_by_id

Update web integration by ID. Updates a single web integration by ID. The id is the id. Required: id.

qlik_sense_web_notifications_all_bulk_delete

Delete all notifications.

qlik_sense_web_notifications_all_bulk_update

Patch all notifications.

delete_a_qlik_sense_web_notification_by_id

Delete a notification. The id is the notificationId. Required: id.

get_single_qlik_sense_web_notification_by_id

Retrieve a single notification by Id. The id is the notificationId. Required: id.

list_all_qlik_sense_web_notifications

Retrieve notifications matching the query. Paginated with limit; Truto follows the next link.

update_a_qlik_sense_web_notification_by_id

Patch a notification. The id is the notificationId. Required: id.

get_single_qlik_sense_webhooks_delivery_by_id

Return details for specific delivery. Returns details for a specific delivery. The id is the deliveryId. Required: id, webhook_id.

list_all_qlik_sense_webhooks_deliveries

Return deliveries for a webhook. Returns deliveries for a specific webhook. Delivery history is stored for 1 week. Required: webhook_id. Paginated with limit; Truto follows the next link.

qlik_sense_webhooks_deliveries_resend

Resend delivery. Resends the delivery with the same payload. Required: delivery_id, webhook_id.

list_all_qlik_sense_webhooks_event_types

List event-types. Lists event-types that are possible to subscribe to.

create_a_qlik_sense_webhook

Create a new webhook. Creates a new webhook. User must be assigned the TenantAdmin role to create tenant level webhooks. Required: name, url.

delete_a_qlik_sense_webhook_by_id

Delete a webhook. Deletes a specific webhook. The id is the id. Required: id.

get_single_qlik_sense_webhook_by_id

Get a webhook. Returns details for a specific webhook. The id is the id. Required: id.

list_all_qlik_sense_webhooks

List webhooks. Retrieves all webhooks entries for a tenant that the user has access to. Users assigned the TenantAdmin role can retrieve all webhooks. A user can have up to 150 webhooks at one time. Paginated with limit; Truto follows the next link.

qlik_sense_webhooks_replace

Update all webhook properties. Updates a webhook, any omitted fields will be cleared, returns updated webhook. Required: webhook_id, name, url.

update_a_qlik_sense_webhook_by_id

Update one or more webhook properties. Patches a webhook to update one or more properties. The id is the id. Required: id.