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 Direct Access Agents API

API for remotely managing configuration settings of Direct Access Gateway agents.

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

Tagged areas include Business Intelligence and REST. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 15 operations across 10 paths, organized into 2 resource areas, and defines 32 schemas. It is described by OpenAPI 3.0.0.

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

15 operations 10 paths 32 schemas 7 GET1 PATCH3 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents
Resource Areas
2

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 7 GET, 1 PATCH, 3 POST, 4 PUT. They span 2 resource areas: direct-access-agent-configuration, direct-access-agent-benchmarking. 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
getConnectorFileListAsync 1 param → 200404
PUT
/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths
Set file connector allowed paths configuration
putConnectorFlatFileConfigurationAsync 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
direct-access-agent-benchmarking 3
POST
/api/v1/direct-access-agents/{agentId}/benchmarks
Start agent benchmark
runBenchmark 3 params → 201403404500501503
GET
/api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}
Get benchmark status
getBenchmarkStatus 2 params → 200403404500503
POST
/api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}/cancel
Requests a cancellation on a running benchmark
cancelBenchmark 2 params → 202403404500503

Schemas 32

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-direct-access-agents.json Raw ↑

Other APIs Qlik Sense APIs publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Apps API
Qlik Change stores API
Qlik Adaptive cards API
Qlik ODAG apps API
Qlik ODAG links API
Qlik ODAG requests API
Qlik ODAG settings API
Qlik API keys API
Where this information came from

This is an independent, third-party profile of Qlik Direct Access Agents 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.