Qlik Sense Direct Access Agent Configuration API

The direct-access-agent-configuration API from Qlik Sense — 7 operation(s) for direct-access-agent-configuration.

Documentation GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/v1/direct-access-agents/{agentId}/actions/{agentAction} Restart a Direct Access Gateway agent · Restart an agent #

Ask an LLM

“How do I restart a Direct Access Gateway agent remotely?”

“Can I force an agent restart even while a reload is still RELOADING?”

Tell an agent

Run the {agentAction} action on agent {agentId}.

Force-restart gateway agent {agentId} using action {agentAction}.

GET /api/v1/direct-access-agents/{agentId}/configurations Get a gateway agent configuration · Get agent configuration #

Ask an LLM

“Where can I read the local configuration of a Direct Access Gateway agent?”

“Can I fetch only certain properties of an agent's configuration?”

Tell an agent

Show the configuration of agent {agentId}.

Get the {queryProperties} properties from agent {agentId}'s configuration.

PATCH /api/v1/direct-access-agents/{agentId}/configurations Patch a gateway agent configuration · Update agent configuration #

Ask an LLM

“How do I change a setting in a gateway agent's local configuration with JSON Patch?”

“Can I edit just one property of the agent configuration without replacing it all?”

Tell an agent

Apply a JSON Patch to the configuration of agent {agentId}.

Update the local agent configuration on {agentId}.

GET /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files List a connector's configuration files · Get connector configuration files #

Ask an LLM

“Which configuration files does a given connector have on a gateway agent?”

“What config files exist for a connector type on my Direct Access agent?”

Tell an agent

List the configuration files for connector {connectorType} on agent {agentId}.

Which config files does connector {connectorType} have on gateway agent {agentId}: list them.

GET /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType} Read a connector configuration file · Get connector configuration #

Ask an LLM

“How can I read the items inside a connector's flat configuration file?”

“What settings are in a specific config file for a connector on the gateway?”

Tell an agent

Show the contents of file {fileType} for connector {connectorType} on agent {agentId}.

Read the {fileType} flat file settings of connector {connectorType} on gateway agent {agentId}.

PUT /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType} Replace a connector configuration file · Set connector configuration #

Ask an LLM

“How do I overwrite a connector's flat configuration file on the gateway agent?”

“Does saving a connector config file replace the whole file or merge changes?”

Tell an agent

Replace config file {fileType} for connector {connectorType} on agent {agentId} with {contentsToSave}.

Overwrite the {fileType} file of connector {connectorType} on agent {agentId}.

GET /api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths Get File Connector allowed paths · Get file connector allowed paths configuration #

Ask an LLM

“Which folders is the File Connector allowed to read on my gateway agent?”

“How can I check the allowed paths set for the File Connector?”

Tell an agent

Show the File Connector allowed paths on agent {agentId}.

Which folders can the File Connector read on agent {agentId}: show them.

PUT /api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths Set File Connector allowed paths · Set file connector allowed paths configuration #

Ask an LLM

“How do I change which paths the File Connector may access?”

“Can I add a new allowed folder for the File Connector on a gateway?”

Tell an agent

Set the File Connector allowed paths on agent {agentId} to {fileConnectorAllowedPaths}.

Replace the File Connector allowed folders on gateway agent {agentId}.

GET /api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings Get ODBC custom data type mappings · Get connector type mapping configuration #

Ask an LLM

“What custom data type mappings are configured for the Generic ODBC Connector?”

“Where can I see how ODBC column types are mapped on a gateway agent?”

Tell an agent

Show the Generic ODBC custom data type mappings on agent {agentId}.

Read how ODBC column types are mapped on gateway agent {agentId}.

PUT /api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings Set ODBC custom data type mappings · Set connector type mapping configuration #

Ask an LLM

“How do I define custom data type mappings for the Generic ODBC Connector?”

“Does updating ODBC type mappings replace the entire mapping file?”

Tell an agent

Replace the ODBC custom data type mappings on agent {agentId} with {odbcCustomDataTypes}.

Set new Generic ODBC type mappings on gateway agent {agentId}.

GET /api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration Get metrics collector settings · Get metrics collector settings #

Ask an LLM

“What are the current metrics collector settings on a gateway agent?”

“Is the metrics collector configured on my Direct Access agent?”

Tell an agent

Show the metrics collector settings for agent {agentId}.

Check whether the metrics collector is configured on gateway agent {agentId}.

PUT /api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration Set metrics collector settings · Set metrics collector settings #

Ask an LLM

“How do I configure the metrics collector on a Direct Access Gateway agent?”

“Can I choose which connectors the metrics collector gathers data for?”

Tell an agent

Set metrics collector settings on agent {agentId} to {metricsCollectorSettings} for connectors {connectorConfigurations}.

Configure the metrics collector on gateway agent {agentId} with {metricsCollectorSettings} and {connectorConfigurations}.

Qlik Sense Direct Access Agent Configuration API

Operations 12

Documentation

Specifications

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification