How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Sense Direct Access Agent Configuration API

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

Qlik Sense Direct Access Agent Configuration API is one of 135 APIs that Qlik Sense publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include direct-access-agent-configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 12 operations across 7 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.

12 operations 7 paths 27 schemas 6 GET1 PATCH1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
wss://your-tenant.qlikcloud.com/app/
Resource Areas
1

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 6 GET, 1 PATCH, 1 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

direct-access-agent-configuration 12
POST
/api/v1/direct-access-agents/{agentId}/actions/{agentAction}
Restart an agent
restartConnectorAgentServiceAsync 2 params → 204400403404409500
GET
/api/v1/direct-access-agents/{agentId}/configurations
Get agent configuration
getConnectorAgentConfigAsync 2 params → 200403404
PATCH
/api/v1/direct-access-agents/{agentId}/configurations
Update agent configuration
patchConnectorAgentConfigurationAsync 1 param body → 204207400403404415
GET
/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files
Get connector configuration files
getConnectorFileListAsync 2 params → 200403404
GET
/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}
Get connector configuration
getConnectorFlatFileConfigurationAsync 3 params → 200403404
PUT
/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}
Set connector configuration
putConnectorFlatFileConfigurationAsync 3 params body → 204400404409
GET
/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths
Get file connector allowed paths configuration
getApiV1DirectAccessAgentsByAgentIdConnectorsFileConnectorFilesAllowedPaths 1 param → 200404
PUT
/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths
Set file connector allowed paths configuration
putApiV1DirectAccessAgentsByAgentIdConnectorsFileConnectorFilesAllowedPaths 1 param body → 204400404409
GET
/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings
Get connector type mapping configuration
getOdbcCustomTypeMappingsAsync 1 param → 200404
PUT
/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings
Set connector type mapping configuration
putOdbcCustomTypeMappingsAsync 1 param body → 204400404409
GET
/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration
Get metrics collector settings
getMetricsCollectorSettingsAsync 1 param → 200400404
PUT
/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration
Set metrics collector settings
putMetricsCollectorSettingsAsync 1 param body → 204400404409

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are ConfigurationLineNumeric (14 properties), ConfigurationLineString (13 properties), UpdateMetricsCollectorConnectorConfigurationsRequest (8 properties), MetricsCollectorConnectorConfigurationsApiResponse (8 properties). Each schema is shown below with its type and property counts.

OdbcCustomDataType
object
5 properties 3 required
UpdateMetricsCollectorSettings
object
7 properties 6 required
UpdateMetricsCollectorSettingsRequest
object
2 properties 2 required
ErrorMessage
object
3 properties
ConnectorSettings
object
2 properties
ConfigurationLineBase
object
ConfigurationLineString
object
13 properties
ConfigurationResponse
object
3 properties
MetricsCollectorConnectorConfigurationApiResponse
object
2 properties 2 required
UpdateMetricsCollectorConnectorConfigurationsRequest
object
8 properties 8 required
UpdateOdbcCustomTypeMappingsRequest
object
1 property
ConnectorFlatFileConfigurationResponse
object
2 properties
PatchOperationResponse
object
4 properties
UpdateConfigurationFlatFileRequest
object
The request to update a connector flat file
1 property
FileConnectorAllowedPath
object
2 properties 1 required
OdbcCustomDataTypeResponse
object
2 properties
MetricsCollectorConnectorConfigurationsApiResponse
object
8 properties
UpdateFileConnectorAllowedPathsRequest
object
The request to update file connector allowed paths configuration
1 property
MetricsCollectorSettingsApiResponseConnectorConfigurationResponse
object
2 properties
MetricsCollectorSettings
object
7 properties 5 required
FileConnectorAllowedPathsResponse
object
2 properties
MetricsCollectorIndividualConnectorConfigurationRequest
object
2 properties 2 required
ErrorResponse
object
3 properties
PatchOperationValidationResult
object
3 properties
Operation
object
3 properties 3 required
ConfigurationLineNumeric
object
14 properties
MetricsCollectorSettingsApiResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-direct-access-agent-configuration-api-openapi.yml Raw ↑

Other APIs Qlik Sense publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Sense Engine API
Qlik Sense Repository API
Qlik Sense Proxy API
Qlik Data Integration API
Qlik Embedding API
Qlik Sense alerting actions API
Qlik Sense alerting settings API
Qlik Sense alerting tasks API
Where this information came from

This is an independent, third-party profile of Qlik Sense Direct Access Agent Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.