API for remotely managing configuration settings of Direct Access Gateway agents.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/direct-access-agents-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"info": {
"title": "direct-access-agents",
"version": ""
},
"paths": {
"/api/v1/direct-access-agents/{agentId}/actions/{agentAction}": {
"post": {
"tags": [
"direct-access-agent-configuration"
],
"summary": "Restart an agent",
"responses": {
"204": {
"description": "Service restarted successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error restarting the service."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The requestor does not have the required permissions for the gateway's space."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Service doesn't exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Conflict"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error"
}
},
"parameters": [
{
"in": "path",
"name": "agentAction",
"schema": {
"type": "string"
},
"required": true,
"description": "The type of action to perform. Permitted values are `restart` (will not restart the agent if a reload is in `RELOADING` status) and `force-restart` (will restart the agent even if a reload is in `RELOADING` status)."
},
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
}
],
"description": "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. 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. Available in Direct Access Gateway V1.7.2+.",
"operationId": "restartConnectorAgentServiceAsync",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/direct-access-agents/{agentId}/benchmarks": {
"post": {
"tags": [
"direct-access-agent-benchmarking"
],
"summary": "Start agent benchmark",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunBenchmarkResponse"
}
}
},
"description": "Benchmark task created successfully with a unique identifier."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The requestor does not have the required permissions for the gateway's space."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The agent was not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "There was an error processing the request."
},
"501": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "All or part of the request has not yet been implemented."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Service is unavailable."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
},
{
"in": "query",
"name": "force",
"schema": {
"type": "boolean",
"default": false
},
"description": "Forces the benchmark to start regardless of the state of the agent. Does not override QCS resource limits. Use with caution."
},
{
"in": "query",
"name": "gigaBytesToTransfer",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
},
"description": "The volume of data in GB to transfer during the throughput measurement part of the benchmark."
}
],
"description": "Starts a background benchmark task to measure the performance of a Direct Access agent. Use this endpoint to evaluate agent throughput and latency for capacity planning and performance optimization. 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. Available in Direct Access Gateway V1.7.8+.",
"operationId": "runBenchmark",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}": {
"get": {
"tags": [
"direct-access-agent-benchmarking"
],
"summary": "Get benchmark status",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBenchmarkStatusResponse"
}
}
},
"description": "Benchmark status and performance metrics retrieved successfully."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The requestor does not have the required permissions for the gateway's space."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The benchmark was not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "There was an error processing the request."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Service is unavailable."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
},
{
"in": "path",
"name": "benchmarkId",
"schema": {
"type": "string"
},
"required": true,
"description": "The benchmark ID"
}
],
"description": "Retrieves the current status and progress of a running or completed benchmark task. Use this endpoint to monitor benchmark execution and retrieve performance metrics once the task is completed. 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. Available in Direct Access Gateway V1.7.8+.",
"operationId": "getBenchmarkStatus",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}/cancel": {
"post": {
"tags": [
"direct-access-agent-benchmarking"
],
"summary": "Requests a cancellation on a running benchmark",
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelBenchmarkResponse"
}
}
},
"headers": {
"Location": {
"schema": {
"type": "string"
},
"description": "URL to check the status of the benchmark"
}
},
"description": "The cancellation was requested successfully."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The requestor does not have the required permissions for the gateway's space."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The benchmark was not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "There was an error processing the request."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Service is unavailable."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
},
{
"in": "path",
"name": "benchmarkId",
"schema": {
"type": "string"
},
"required": true,
"description": "The benchmark ID"
}
],
"description": "Requests a cancellation on a running benchmark by id for 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. Available in Direct Access Gateway V1.7.8+.",
"operationId": "cancelBenchmark",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/direct-access-agents/{agentId}/configurations": {
"get": {
"tags": [
"direct-access-agent-configuration"
],
"summary": "Get agent configuration",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationResponse"
}
}
},
"description": "The dictionary of key/value pairs retrieved from the configuration file."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The requestor does not have the required permissions for the gateway's space."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Configuration file not found."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
},
{
"in": "query",
"name": "queryProperties",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Individual properties within the agent configuration"
}
],
"description": "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. Available in Direct Access Gateway V1.7.2+.",
"operationId": "getConnectorAgentConfigAsync",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"direct-access-agent-configuration"
],
"summary": "Update agent configuration",
"responses": {
"204": {
"description": "Patch applied."
},
"207": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchOperationResponse"
}
}
},
"description": "Patch applied, validation results show success or failure of each individual patch operation."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad request."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The requestor does not have the required permissions for the gateway's space."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Configuration file not found."
},
"415": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Unsupported content-type. This endpoint must include `application/json` as a valid content-type for API compliance, but C# JsonPatchDocument doesn't support it. Requests must use `application/json-patch+json`."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
}
],
"description": "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. Available in Direct Access Gateway V1.7.2+.",
"operationId": "patchConnectorAgentConfigurationAsync",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
}
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
}
}
},
"description": "The JSON Patch document"
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files": {
"get": {
"tags": [
"direct-access-agent-configuration"
],
"summary": "Get connector configuration files",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorFlatFileConfigurationResponse"
}
}
},
"description": "The list of files for the specified connector."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The requestor does not have the required permissions for the gateway's space."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Configuration file not found."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
},
{
"in": "path",
"name": "connectorType",
"schema": {
"enum": [
"file-connector",
"rest-connector",
"odbc-connector"
],
"type": "string"
},
"required": true,
"description": "The connector to retrieve the list of files for"
}
],
"description": "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. Available in Direct Access Gateway V1.7.4+.",
"operationId": "getConnectorFileListAsync",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}": {
"get": {
"tags": [
"direct-access-agent-configuration"
],
"summary": "Get connector configuration",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorFlatFileConfigurationResponse"
}
}
},
"description": "The list of configuration values from the file."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The requestor does not have the required permissions for the gateway's space."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Configuration file not found."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
},
{
"in": "path",
"name": "connectorType",
"schema": {
"enum": [
"file-connector",
"rest-connector",
"odbc-connector"
],
"type": "string"
},
"required": true,
"description": "The connector type to retrieve"
},
{
"in": "path",
"name": "fileType",
"schema": {
"enum": [
"CustomTypesMapping",
"PlainTextConfiguration",
"AllowedPaths",
"AllowedDrivers",
"AllowedDsns",
"CustomAllowedExtensions"
],
"type": "string"
},
"required": true,
"description": "The type of file to retrieve"
}
],
"description": "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. Available in Direct Access Gateway V1.7.4+.",
"operationId": "getConnectorFlatFileConfigurationAsync",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"put": {
"tags": [
"direct-access-agent-configuration"
],
"summary": "Set connector configuration",
"responses": {
"204": {
"description": "Updated."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad request."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Configuration file not found."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Conflict."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
},
{
"in": "path",
"name": "connectorType",
"schema": {
"enum": [
"file-connector",
"rest-connector",
"odbc-connector"
],
"type": "string"
},
"required": true,
"description": "The connector type to update"
},
{
"in": "path",
"name": "fileType",
"schema": {
"enum": [
"CustomTypesMapping",
"PlainTextConfiguration",
"AllowedPaths",
"AllowedDrivers",
"AllowedDsns",
"CustomAllowedExtensions"
],
"type": "string"
},
"required": true,
"description": "The file type to update"
}
],
"description": "Completely replaces the contents of the connector's configuration file. Partial updates are not supported. 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. Available in Direct Access Gateway V1.7.4+.",
"operationId": "putConnectorFlatFileConfigurationAsync",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConfigurationFlatFileRequest"
}
}
},
"description": "The contents of the file to be updated"
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths": {
"get": {
"tags": [
"direct-access-agent-configuration"
],
"summary": "Get file connector allowed paths configuration",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileConnectorAllowedPathsResponse"
}
}
},
"description": "The list of configuration values from the file."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Configuration file not found."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID"
}
],
"description": "Retrieves the allowed paths settings for the File Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.6+.",
"operationId": "getConnectorFileListAsync",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"put": {
"tags": [
"direct-access-agent-configuration"
],
"summary": "Set file connector allowed paths configuration",
"responses": {
"204": {
"description": "Updated."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad request."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Configuration file not found."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Conflict."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent id"
}
],
"description": "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+.",
"operationId": "putConnectorFlatFileConfigurationAsync",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFileConnectorAllowedPathsRequest"
}
}
},
"description": "The contents of the file to be updated"
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings": {
"get": {
"tags": [
"direct-access-agent-configuration"
],
"summary": "Get connector type mapping configuration",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OdbcCustomDataTypeResponse"
}
}
},
"description": "The list of configuration values from the file."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Configuration file not found."
}
},
"parameters": [
{
"in": "path",
"name": "agentId",
"schema": {
"type": "string"
},
"required": true,
"description": "The agent ID."
}
],
"description": "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+.",
"operationId": "getOdbcCustomTypeMappingsAsync",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-direct-access-agents.json