Direct Access Agents

Download OpenAPI spec

API for remotely managing configuration settings of Direct Access Gateway agents. Available to users with the Tenant Admin role in Direct Access Gateway v1.7.2+.

Endpoints

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. 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+.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • agentAction string
    Required

    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).

  • agentId string
    Required

    The agent ID

Responses

204

Service restarted successfully.

400

Error restarting the service.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Service doesn't exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

409

Conflict

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

500

Internal Server Error

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
POST /api/v1/direct-access-agents/{agentId}/actions/{agentAction} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.restartDirectAccessAgent(
  'string',
  'string',
)
qlik direct-access-agent restart 'string' \
  --direct-access-agentId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/actions/{agentAction}" \
-X POST \
-H "Authorization: Bearer <access_token>"

Start an agent benchmark

Replacement available

For new integrations, and when updating your existing integrations, use:

  • POST connectivity/direct-access-agents/{agentId}/benchmarks

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. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.8+.

Facts

Rate limit Tier 2 (100 requests per minute)
Replaced by

Query Parameters

  • description string

    The description for the benchmark task.

    minLength = 0, maxLength = 200, default = ""

  • force boolean

    Forces the benchmark to start regardless of the state of the agent. Does not override QCS resource limits. Use with caution.

    default = false

  • gigaBytesToTransfer integer

    The volume of data in GB to transfer during the throughput measurement part of the benchmark.

    default = 1, format = int32, default = 1

  • name string

    The name to assign to the benchmark task.

    minLength = 0, maxLength = 50, default = ""

Path Parameters

  • agentId string
    Required

    The agent ID

Responses

201

Benchmark task created successfully with a unique identifier.

  • application/json object
    Show application/json properties
    • benchmarkId string

400

Bad Request

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

The agent was not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

500

There was an error processing the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

501

All or part of the request has not yet been implemented.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

503

Service is unavailable.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
POST /api/v1/direct-access-agents/{agentId}/benchmarks 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.createDirectAccessAgentBenchmark(
  'string',
  {},
)
qlik direct-access-agent benchmark create \
  --direct-access-agentId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/benchmarks" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "benchmarkId": "string"
}

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 requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.8+.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID

  • benchmarkId string
    Required

    The benchmark ID

Responses

200

Benchmark status and performance metrics retrieved successfully.

  • application/json object

    Represents the status and performance data for a benchmark task.

    Show application/json properties
    • name string

      The benchmark name

    • status string

      The benchmark status

    • results object

      Contains throughput, latency, transfer volume, and transmission timing for a benchmark.

      Show results properties
      • latency integer

        The latency in ms measured during data transmission

        format = int64

      • throughput integer

        The data throughput in KB/s measured during data transmission

        format = int64

      • connectorLatency integer

        The average latency in ms measured on the connector side during data transmission. Null if no connector benchmark data is available.

        format = int64

      • totalBytesTransferred integer

        The total number of bytes successfully transferred during data transmission

        format = int64

      • dataTransmissionEndTime string

        The ISO 8601 formatted timestamp when data transmission completed

        format = "date-time"

      • dataTransmissionStartTime string

        The ISO 8601 formatted timestamp when data transmission start

        format = "date-time"

    • benchmarkId string

      The benchmark ID

    • description string

      The benchmark description

    • statusMessage string

      Additional details about the benchmark status

    • benchmarkEndTime string

      The ISO 8601 formatted timestamp when the benchmark task completed or was cancelled

      format = "date-time"

    • concurrentReloads integer

      Number of concurrent benchmarks/reloads observed when this benchmark was started

      format = int32

    • benchmarkStartTime string

      The ISO 8601 formatted timestamp when the benchmark task started execution

      format = "date-time"

    • totalBytesRequested integer

      The total bytes requested to be transferred during the benchmark

      format = int64

    • getReloadSlotEndTime string

      The ISO 8601 formatted timestamp when get reload slot completed

      format = "date-time"

    • dataGenerationEndTime string

      The ISO 8601 formatted timestamp when data generation completed

      format = "date-time"

    • getReloadSlotStartTime string

      The ISO 8601 formatted timestamp when get reload slot started

      format = "date-time"

    • dataGenerationStartTime string

      The ISO 8601 formatted timestamp when data generation started

      format = "date-time"

403

The requestor does not have the required permissions for the gateway's space.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

The benchmark was not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

500

There was an error processing the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

503

Service is unavailable.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
GET /api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.getDirectAccessAgentBenchmark(
  'string',
  'string',
)
qlik direct-access-agent benchmark get 'string' \
  --direct-access-agentId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "name": "string",
  "status": "string",
  "results": {
    "latency": 42,
    "throughput": 42,
    "connectorLatency": 42,
    "totalBytesTransferred": 42,
    "dataTransmissionEndTime": "2026-03-11T20:54:34.437Z",
    "dataTransmissionStartTime": "2026-03-11T20:52:05.308Z"
  },
  "benchmarkId": "string",
  "description": "string",
  "statusMessage": "string",
  "benchmarkEndTime": "2026-03-11T20:54:34.438Z",
  "concurrentReloads": 42,
  "benchmarkStartTime": "2026-03-11T20:51:15.927Z",
  "totalBytesRequested": 42,
  "getReloadSlotEndTime": "2026-03-11T20:51:22.000Z",
  "dataGenerationEndTime": "2026-03-11T20:51:40.000Z",
  "getReloadSlotStartTime": "2026-03-11T20:51:20.000Z",
  "dataGenerationStartTime": "2026-03-11T20:51:23.000Z"
}

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. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.8+.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID

  • benchmarkId string
    Required

    The benchmark ID

Responses

202

The cancellation was requested successfully.

  • application/json object
    Show application/json properties
    • message string
    • statusUrl object
      Show statusUrl properties
      • href string

        The URL to the related resource

403

The requestor does not have the required permissions for the gateway's space.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

The benchmark was not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

500

There was an error processing the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

503

Service is unavailable.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
POST /api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}/cancel 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.createDirectAccessAgentBenchmarkCancel(
  'string',
  'string',
)
qlik direct-access-agent benchmark cancel \
  --direct-access-agentId 'string' \
  --benchmarkId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}/cancel" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "message": "string",
  "statusUrl": {
    "href": "string"
  }
}

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. Available in Direct Access Gateway V1.7.2+.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • queryProperties array of strings

    Individual properties within the agent configuration

Path Parameters

  • agentId string
    Required

    The agent ID

Responses

200

The dictionary of key/value pairs retrieved from the configuration file.

  • application/json object
    Show application/json properties
    • connectors array of objects
      Show connectors properties
      • settings array of objects
        One of:
        • ConfigurationLineNumeric object
          Show ConfigurationLineNumeric properties
          • name string
          • value string
          • connector string
          • uiActions array of strings

            Values may be any of: "Read""Write"

          • apiActions array of strings

            Values may be any of: "Read""Write"

          • description string
          • displayName string
          • defaultValue string
          • pendingValue string
          • skipValidation boolean
          • permittedRangeEnd integer

            format = int32

          • pendingApplication boolean
          • allowMultipleValues boolean
          • applyWithoutRestart boolean
          • permittedRangeStart integer

            format = int32

        • ConfigurationLineString object
          Show ConfigurationLineString properties
          • name string
          • value string
          • connector string
          • uiActions array of strings

            Values may be any of: "Read""Write"

          • apiActions array of strings

            Values may be any of: "Read""Write"

          • description string
          • displayName string
          • defaultValue string
          • pendingValue string
          • skipValidation boolean
          • permittedValues array of strings
          • pendingApplication boolean
          • allowMultipleValues boolean
          • applyWithoutRestart boolean
      • connectorName string
    • environment string
    • dcaasSettings array of objects
      One of:
      • ConfigurationLineNumeric object
        Show ConfigurationLineNumeric properties
        • name string
        • value string
        • connector string
        • uiActions array of strings

          Values may be any of: "Read""Write"

        • apiActions array of strings

          Values may be any of: "Read""Write"

        • description string
        • displayName string
        • defaultValue string
        • pendingValue string
        • skipValidation boolean
        • permittedRangeEnd integer

          format = int32

        • pendingApplication boolean
        • allowMultipleValues boolean
        • applyWithoutRestart boolean
        • permittedRangeStart integer

          format = int32

      • ConfigurationLineString object
        Show ConfigurationLineString properties
        • name string
        • value string
        • connector string
        • uiActions array of strings

          Values may be any of: "Read""Write"

        • apiActions array of strings

          Values may be any of: "Read""Write"

        • description string
        • displayName string
        • defaultValue string
        • pendingValue string
        • skipValidation boolean
        • permittedValues array of strings
        • pendingApplication boolean
        • allowMultipleValues boolean
        • applyWithoutRestart boolean
    • productVersion string
    • connectorAgentSettings array of objects
      One of:
      • ConfigurationLineNumeric object
        Show ConfigurationLineNumeric properties
        • name string
        • value string
        • connector string
        • uiActions array of strings

          Values may be any of: "Read""Write"

        • apiActions array of strings

          Values may be any of: "Read""Write"

        • description string
        • displayName string
        • defaultValue string
        • pendingValue string
        • skipValidation boolean
        • permittedRangeEnd integer

          format = int32

        • pendingApplication boolean
        • allowMultipleValues boolean
        • applyWithoutRestart boolean
        • permittedRangeStart integer

          format = int32

      • ConfigurationLineString object
        Show ConfigurationLineString properties
        • name string
        • value string
        • connector string
        • uiActions array of strings

          Values may be any of: "Read""Write"

        • apiActions array of strings

          Values may be any of: "Read""Write"

        • description string
        • displayName string
        • defaultValue string
        • pendingValue string
        • skipValidation boolean
        • permittedValues array of strings
        • pendingApplication boolean
        • allowMultipleValues boolean
        • applyWithoutRestart boolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
GET /api/v1/direct-access-agents/{agentId}/configurations 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.getDirectAccessAgentConfiguration(
  'string',
  {},
)
qlik direct-access-agent configuration ls 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/configurations" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "connectors": [
    {
      "settings": [
        {
          "name": "string",
          "value": "string",
          "connector": "string",
          "uiActions": [
            "Read"
          ],
          "apiActions": [
            "Read"
          ],
          "description": "string",
          "displayName": "string",
          "defaultValue": "string",
          "pendingValue": "string",
          "skipValidation": true,
          "permittedRangeEnd": 42,
          "pendingApplication": true,
          "allowMultipleValues": true,
          "applyWithoutRestart": true,
          "permittedRangeStart": 42
        }
      ],
      "connectorName": "string"
    }
  ],
  "environment": "string",
  "dcaasSettings": [
    {
      "name": "string",
      "value": "string",
      "connector": "string",
      "uiActions": [
        "Read"
      ],
      "apiActions": [
        "Read"
      ],
      "description": "string",
      "displayName": "string",
      "defaultValue": "string",
      "pendingValue": "string",
      "skipValidation": true,
      "permittedRangeEnd": 42,
      "pendingApplication": true,
      "allowMultipleValues": true,
      "applyWithoutRestart": true,
      "permittedRangeStart": 42
    }
  ],
  "productVersion": "string",
  "connectorAgentSettings": [
    {
      "name": "string",
      "value": "string",
      "connector": "string",
      "uiActions": [
        "Read"
      ],
      "apiActions": [
        "Read"
      ],
      "description": "string",
      "displayName": "string",
      "defaultValue": "string",
      "pendingValue": "string",
      "skipValidation": true,
      "permittedRangeEnd": 42,
      "pendingApplication": true,
      "allowMultipleValues": true,
      "applyWithoutRestart": true,
      "permittedRangeStart": 42
    }
  ]
}

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. Available in Direct Access Gateway V1.7.2+.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID

Request Body

The JSON Patch document

  • application/json array of objects
    Show application/json properties
    • op string
      Required

      Can be one of: "add""replace""remove"

    • path string
      Required

      Can be one of: "AGENT_LOG_LEVEL""AGENT_HEALTH_FAIL_MINUTES_LIMIT""AGENT_LOG_OPTIONS""EXTEND_FIRST_REQUEST_TIMEOUT""RELOAD_CACHE_MEMORY_MB""DCAAS_LOG_LEVEL""ODBC_LOG_LEVEL""ODBC_MAX_PROCESS_COUNT""ODBC_PROCESS_ISOLATION_MODE""ODBC_RELOAD_SESSION_LIFE""SAPBW_LOG_LEVEL""SAPBW_MAX_PROCESS_COUNT""SAPBW_PROCESS_ISOLATION_MODE""SAPSQL_LOG_LEVEL""SAPSQL_MAX_PROCESS_COUNT""SAPSQL_PROCESS_ISOLATION_MODE""SAPPACKAGE_LOG_LEVEL""SAPPACKAGE_MAX_PROCESS_COUNT""SAPPACKAGE_PROCESS_ISOLATION_MODE""FILE_LOG_LEVEL""FILE_MAX_PROCESS_COUNT""FILE_PROCESS_ISOLATION_MODE""REST_LOG_LEVEL""REST_MAX_PROCESS_COUNT""REST_PROCESS_ISOLATION_MODE""ODBC_TABLES_LIMIT_FOR_GENERICODBC""OVERRIDE_CHUNKS_CACHE_DIR""CHUNK_RECOVERY_RESUME_THRESHOLD_MINUTES""REST_ALLOW_LOCALHOST_CONNECTION""OPTIONAL_CAPABILITIES""AGENT_LOG_MAX_FILE_SIZE_MB""AGENT_LOG_RETENTION_DAYS""METRICS_LOG_MAX_FILE_SIZE_MB""METRICS_LOG_RETENTION_DAYS""DCAAS_LOG_RETENTION_DAYS""ODBC_LOG_RETENTION_DAYS""SAPBW_LOG_RETENTION_DAYS""SAPSQL_LOG_RETENTION_DAYS""SAPPACKAGE_LOG_RETENTION_DAYS""REST_LOG_RETENTION_DAYS""FILE_LOG_RETENTION_DAYS""BENCHMARK_LOAD_PERFORMANCE_METRICS_RECORDING_ENABLED""BENCHMARK_RETENTION_CLEANUP_ENABLED""BENCHMARK_RETENTION_DAYS""BENCHMARK_RETENTION_CHECK_INTERVAL_MINUTES""BENCHMARK_RETENTION_DB_SIZE_MB""BENCHMARK_RETENTION_CLEANUP_BATCH_SIZE"

    • value string
      Required

The JSON Patch document

  • application/json-patch+json array of objects
    Show application/json-patch+json properties
    • op string
      Required

      Can be one of: "add""replace""remove"

    • path string
      Required

      Can be one of: "AGENT_LOG_LEVEL""AGENT_HEALTH_FAIL_MINUTES_LIMIT""AGENT_LOG_OPTIONS""EXTEND_FIRST_REQUEST_TIMEOUT""RELOAD_CACHE_MEMORY_MB""DCAAS_LOG_LEVEL""ODBC_LOG_LEVEL""ODBC_MAX_PROCESS_COUNT""ODBC_PROCESS_ISOLATION_MODE""ODBC_RELOAD_SESSION_LIFE""SAPBW_LOG_LEVEL""SAPBW_MAX_PROCESS_COUNT""SAPBW_PROCESS_ISOLATION_MODE""SAPSQL_LOG_LEVEL""SAPSQL_MAX_PROCESS_COUNT""SAPSQL_PROCESS_ISOLATION_MODE""SAPPACKAGE_LOG_LEVEL""SAPPACKAGE_MAX_PROCESS_COUNT""SAPPACKAGE_PROCESS_ISOLATION_MODE""FILE_LOG_LEVEL""FILE_MAX_PROCESS_COUNT""FILE_PROCESS_ISOLATION_MODE""REST_LOG_LEVEL""REST_MAX_PROCESS_COUNT""REST_PROCESS_ISOLATION_MODE""ODBC_TABLES_LIMIT_FOR_GENERICODBC""OVERRIDE_CHUNKS_CACHE_DIR""CHUNK_RECOVERY_RESUME_THRESHOLD_MINUTES""REST_ALLOW_LOCALHOST_CONNECTION""OPTIONAL_CAPABILITIES""AGENT_LOG_MAX_FILE_SIZE_MB""AGENT_LOG_RETENTION_DAYS""METRICS_LOG_MAX_FILE_SIZE_MB""METRICS_LOG_RETENTION_DAYS""DCAAS_LOG_RETENTION_DAYS""ODBC_LOG_RETENTION_DAYS""SAPBW_LOG_RETENTION_DAYS""SAPSQL_LOG_RETENTION_DAYS""SAPPACKAGE_LOG_RETENTION_DAYS""REST_LOG_RETENTION_DAYS""FILE_LOG_RETENTION_DAYS""BENCHMARK_LOAD_PERFORMANCE_METRICS_RECORDING_ENABLED""BENCHMARK_RETENTION_CLEANUP_ENABLED""BENCHMARK_RETENTION_DAYS""BENCHMARK_RETENTION_CHECK_INTERVAL_MINUTES""BENCHMARK_RETENTION_DB_SIZE_MB""BENCHMARK_RETENTION_CLEANUP_BATCH_SIZE"

    • value string
      Required

Responses

204

Patch applied.

207

Patch applied, validation results show success or failure of each individual patch operation.

  • application/json object
    Show application/json properties
    • data array of objects
      Show data properties
      • valid boolean
      • operation object
        Show operation properties
        • op string
          Required

          Can be one of: "add""replace""remove"

        • path string
          Required

          Can be one of: "AGENT_LOG_LEVEL""AGENT_HEALTH_FAIL_MINUTES_LIMIT""AGENT_LOG_OPTIONS""EXTEND_FIRST_REQUEST_TIMEOUT""RELOAD_CACHE_MEMORY_MB""DCAAS_LOG_LEVEL""ODBC_LOG_LEVEL""ODBC_MAX_PROCESS_COUNT""ODBC_PROCESS_ISOLATION_MODE""ODBC_RELOAD_SESSION_LIFE""SAPBW_LOG_LEVEL""SAPBW_MAX_PROCESS_COUNT""SAPBW_PROCESS_ISOLATION_MODE""SAPSQL_LOG_LEVEL""SAPSQL_MAX_PROCESS_COUNT""SAPSQL_PROCESS_ISOLATION_MODE""SAPPACKAGE_LOG_LEVEL""SAPPACKAGE_MAX_PROCESS_COUNT""SAPPACKAGE_PROCESS_ISOLATION_MODE""FILE_LOG_LEVEL""FILE_MAX_PROCESS_COUNT""FILE_PROCESS_ISOLATION_MODE""REST_LOG_LEVEL""REST_MAX_PROCESS_COUNT""REST_PROCESS_ISOLATION_MODE""ODBC_TABLES_LIMIT_FOR_GENERICODBC""OVERRIDE_CHUNKS_CACHE_DIR""CHUNK_RECOVERY_RESUME_THRESHOLD_MINUTES""REST_ALLOW_LOCALHOST_CONNECTION""OPTIONAL_CAPABILITIES""AGENT_LOG_MAX_FILE_SIZE_MB""AGENT_LOG_RETENTION_DAYS""METRICS_LOG_MAX_FILE_SIZE_MB""METRICS_LOG_RETENTION_DAYS""DCAAS_LOG_RETENTION_DAYS""ODBC_LOG_RETENTION_DAYS""SAPBW_LOG_RETENTION_DAYS""SAPSQL_LOG_RETENTION_DAYS""SAPPACKAGE_LOG_RETENTION_DAYS""REST_LOG_RETENTION_DAYS""FILE_LOG_RETENTION_DAYS""BENCHMARK_LOAD_PERFORMANCE_METRICS_RECORDING_ENABLED""BENCHMARK_RETENTION_CLEANUP_ENABLED""BENCHMARK_RETENTION_DAYS""BENCHMARK_RETENTION_CHECK_INTERVAL_MINUTES""BENCHMARK_RETENTION_DB_SIZE_MB""BENCHMARK_RETENTION_CLEANUP_BATCH_SIZE"

        • value string
          Required
      • validationResult string
    • errorMessage string
    • httpStatusCode integer

      format = int32

    • failedPatchError object
      Show failedPatchError properties
      • errors array of objects
        Show errors properties
        • code string
        • title string
        • detail string
      • traceId string
      • hasErrors boolean

400

Bad request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

415

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.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
PATCH /api/v1/direct-access-agents/{agentId}/configurations 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.patchDirectAccessAgentConfiguration(
  'string',
  [
    {
      op: 'add',
      path: 'AGENT_LOG_LEVEL',
      value: 'string',
    },
  ],
)
qlik direct-access-agent configuration patch 'string' \
  --op 'add' \
  --path 'AGENT_LOG_LEVEL' \
  --value 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/configurations" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"add","path":"AGENT_LOG_LEVEL","value":"string"}]'

Example Response

{
  "data": [
    {
      "valid": true,
      "operation": {
        "op": "add",
        "path": "AGENT_LOG_LEVEL",
        "value": "string"
      },
      "validationResult": "string"
    }
  ],
  "errorMessage": "string",
  "httpStatusCode": 42,
  "failedPatchError": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

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. Available in Direct Access Gateway V1.7.4+.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID

  • connectorType string
    Required

    The connector to retrieve the list of files for

    Can be one of: "file-connector""rest-connector""odbc-connector"

Responses

200

The list of files for the specified connector.

  • application/json object
    Show application/json properties
    • result array of strings
    • errorMessage object
      Show errorMessage properties
      • errors array of objects
        Show errors properties
        • code string
        • title string
        • detail string
      • traceId string
      • hasErrors boolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
GET /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.getDirectAccessAgentConnectorFilesWithoutQuery(
  'string',
  'file-connector',
)
qlik direct-access-agent connector file ls \
  --direct-access-agentId 'string' \
  --connectorType 'file-connector'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "result": [
    "string"
  ],
  "errorMessage": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

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. Available in Direct Access Gateway V1.7.4+.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID

  • connectorType string
    Required

    The connector type to retrieve

    Can be one of: "file-connector""rest-connector""odbc-connector"

  • fileType string
    Required

    The type of file to retrieve

    Can be one of: "CustomTypesMapping""PlainTextConfiguration""AllowedPaths""AllowedDrivers""AllowedDsns""CustomAllowedExtensions"

Responses

200

The list of configuration values from the file.

  • application/json object
    Show application/json properties
    • result array of strings
    • errorMessage object
      Show errorMessage properties
      • errors array of objects
        Show errors properties
        • code string
        • title string
        • detail string
      • traceId string
      • hasErrors boolean

403

The requestor does not have the required permissions for the gateway's space.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
GET /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.getDirectAccessAgentConnectorFile(
  'string',
  'file-connector',
  'CustomTypesMapping',
)
qlik direct-access-agent connector file get 'CustomTypesMapping' \
  --direct-access-agentId 'string' \
  --connectorType 'file-connector'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "result": [
    "string"
  ],
  "errorMessage": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

Set connector configuration

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+.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID

  • connectorType string
    Required

    The connector type to update

    Can be one of: "file-connector""rest-connector""odbc-connector"

  • fileType string
    Required

    The file type to update

    Can be one of: "CustomTypesMapping""PlainTextConfiguration""AllowedPaths""AllowedDrivers""AllowedDsns""CustomAllowedExtensions"

Request Body

The contents of the file to be updated

  • application/json object

    The request to update a connector flat file

    Show application/json properties
    • contentsToSave array of strings

      Individual lines of the file. Must be escaped when sending as json.

Responses

204

Updated.

400

Bad request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

409

Conflict.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
PUT /api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.updateDirectAccessAgentConnectorFileWithoutQuery(
  'string',
  'file-connector',
  'CustomTypesMapping',
  { contentsToSave: ['C:\\\\filepath'] },
)
qlik direct-access-agent connector file update 'CustomTypesMapping' \
  --direct-access-agentId 'string' \
  --connectorType 'file-connector'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"contentsToSave":["C:\\\\filepath"]}'

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+.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID

Responses

200

The list of configuration values from the file.

  • application/json object
    Show application/json properties
    • result array of objects
      Show result properties
      • path string
        Required

        The Path property in the File connector allowed paths file.

        minLength = 1

      • spaces array of strings

        The Spaces property in the File connector allowed paths file.
    • errorMessage object
      Show errorMessage properties
      • errors array of objects
        Show errors properties
        • code string
        • title string
        • detail string
      • traceId string
      • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
GET /api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths(
  'string',
)
qlik direct-access-agent connector file allowed-paths get 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "result": [
    {
      "path": "\\\\\\\\Server\\\\Share\\\\example",
      "spaces": [
        "Foo",
        "Bar"
      ]
    }
  ],
  "errorMessage": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

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+.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent id

Request Body

The contents of the file to be updated

  • application/json object

    The request to update file connector allowed paths configuration

    Show application/json properties
    • fileConnectorAllowedPaths array of objects
      Show fileConnectorAllowedPaths properties
      • path string
        Required

        The Path property in the File connector allowed paths file.

        minLength = 1

      • spaces array of strings

        The Spaces property in the File connector allowed paths file.

Responses

204

Updated.

400

Bad request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

409

Conflict.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
PUT /api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths(
  'string',
  {
    fileConnectorAllowedPaths: [
      {
        path: '\\\\\\\\Server\\\\Share\\\\example',
        spaces: ['Foo', 'Bar'],
      },
    ],
  },
)
qlik direct-access-agent connector file allowed-paths update 'string' \
  --fileConnectorAllowedPaths-path ''
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"fileConnectorAllowedPaths":[{"path":"\\\\\\\\Server\\\\Share\\\\example","spaces":["Foo","Bar"]}]}'

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+.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID.

Responses

200

The list of configuration values from the file.

  • application/json object
    Show application/json properties
    • result array of objects
      Show result properties
      • id string
        Required

        The Identifier property in the ODBC custom data type mapping file.

        minLength = 1

      • bit boolean

        The IsBit property in the ODBC custom data type mapping file.

      • size integer

        The Size property in the ODBC custom data type mapping file.

        default = 0, format = int32, default = 0

      • qlikDataType string
        Required

        The QlikDataType property in the ODBC custom data type mapping file.

        minLength = 1

      • nativeDataType string
        Required

        The NativeDataType property in the ODBC custom data type mapping file.

        minLength = 1

    • errorMessage object
      Show errorMessage properties
      • errors array of objects
        Show errors properties
        • code string
        • title string
        • detail string
      • traceId string
      • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
GET /api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings(
  'string',
)
qlik direct-access-agent connector file custom-data-type-mappings get 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "result": [
    {
      "id": "Amazon Athena ODBC (x64)",
      "bit": true,
      "size": 0,
      "qlikDataType": "String",
      "nativeDataType": "varchar"
    }
  ],
  "errorMessage": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

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. Use the API property format when making changes. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.5+.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID.

Request Body

The contents of the file to be updated.

  • application/json object
    Show application/json properties
    • odbcCustomDataTypes array of objects
      Show odbcCustomDataTypes properties
      • id string
        Required

        The Identifier property in the ODBC custom data type mapping file.

        minLength = 1

      • bit boolean

        The IsBit property in the ODBC custom data type mapping file.

      • size integer

        The Size property in the ODBC custom data type mapping file.

        default = 0, format = int32, default = 0

      • qlikDataType string
        Required

        The QlikDataType property in the ODBC custom data type mapping file.

        minLength = 1

      • nativeDataType string
        Required

        The NativeDataType property in the ODBC custom data type mapping file.

        minLength = 1

Responses

204

Updated.

400

Bad request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

409

Conflict.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
PUT /api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings(
  'string',
  {
    odbcCustomDataTypes: [
      {
        id: 'Amazon Athena ODBC (x64)',
        bit: true,
        size: 0,
        qlikDataType: 'String',
        nativeDataType: 'varchar',
      },
    ],
  },
)
qlik direct-access-agent connector file custom-data-type-mappings update 'string' \
  --odbcCustomDataTypes-id '' \
  --odbcCustomDataTypes-nativeDataType '' \
  --odbcCustomDataTypes-qlikDataType ''
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"odbcCustomDataTypes":[{"id":"Amazon Athena ODBC (x64)","bit":true,"size":0,"qlikDataType":"String","nativeDataType":"varchar"}]}'

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+.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID.

Responses

200

The list of configuration values from the file.

  • application/json object
    Show application/json properties
    • result object
      Show result properties
      • connectorConfigurations object
        Show connectorConfigurations properties
        • fileConnector object
          Show fileConnector properties
          • scrapeIntervalSeconds integer
            Required

            Frequency in seconds at which metrics are collected from this connector.

            default = 30, format = int32, default = 30

          • metricsCollectionEnabled boolean
            Required

            Indicates whether metrics collection is enabled for this connector.

            default = false

        • odbcConnector object
          Show odbcConnector properties
          • scrapeIntervalSeconds integer
            Required

            Frequency in seconds at which metrics are collected from this connector.

            default = 30, format = int32, default = 30

          • metricsCollectionEnabled boolean
            Required

            Indicates whether metrics collection is enabled for this connector.

            default = false

        • restConnector object
          Show restConnector properties
          • scrapeIntervalSeconds integer
            Required

            Frequency in seconds at which metrics are collected from this connector.

            default = 30, format = int32, default = 30

          • metricsCollectionEnabled boolean
            Required

            Indicates whether metrics collection is enabled for this connector.

            default = false

        • systemMetrics object
          Show systemMetrics properties
          • scrapeIntervalSeconds integer
            Required

            Frequency in seconds at which metrics are collected from this connector.

            default = 30, format = int32, default = 30

          • metricsCollectionEnabled boolean
            Required

            Indicates whether metrics collection is enabled for this connector.

            default = false

        • connectorAgent object
          Show connectorAgent properties
          • scrapeIntervalSeconds integer
            Required

            Frequency in seconds at which metrics are collected from this connector.

            default = 30, format = int32, default = 30

          • metricsCollectionEnabled boolean
            Required

            Indicates whether metrics collection is enabled for this connector.

            default = false

        • sapBwConnector object
          Show sapBwConnector properties
          • scrapeIntervalSeconds integer
            Required

            Frequency in seconds at which metrics are collected from this connector.

            default = 30, format = int32, default = 30

          • metricsCollectionEnabled boolean
            Required

            Indicates whether metrics collection is enabled for this connector.

            default = false

        • sapSqlConnector object
          Show sapSqlConnector properties
          • scrapeIntervalSeconds integer
            Required

            Frequency in seconds at which metrics are collected from this connector.

            default = 30, format = int32, default = 30

          • metricsCollectionEnabled boolean
            Required

            Indicates whether metrics collection is enabled for this connector.

            default = false

        • sapPackageConnector object
          Show sapPackageConnector properties
          • scrapeIntervalSeconds integer
            Required

            Frequency in seconds at which metrics are collected from this connector.

            default = 30, format = int32, default = 30

          • metricsCollectionEnabled boolean
            Required

            Indicates whether metrics collection is enabled for this connector.

            default = false

      • metricsCollectorSettings object
        Show metricsCollectorSettings properties
        • port integer
          Required

          The port number that the metrics collector API will run on. This must match the port that the SYSTEM connector runs on to enable network metrics collection.

          default = 5052, format = int32, default = 5052

        • enabled boolean
          Required

          Indicates whether the metrics collector is enabled.

          default = false

        • localDataRetentionDays integer
          Required

          The number of days to retain local data.

          default = 30, format = int32, default = 30

        • baseScrapeIntervalSeconds integer
          Required

          The base interval in seconds for the metrics collection loop. This defines how frequently the collector checks whether to scrape each connector, not the interval at which each connector is scraped. Must be equal to or less than the lowest individual connector scrape interval.

          default = 1, format = int32, default = 1

        • localDatabaseFileLocation string

          The file location for the local metrics database. If not specified, defaults to %ProgramData%\Qlik\Gateway\tmp.

          default = ""

        • dataRetentionCheckIntervalMinutes integer
          Required

          The interval in minutes the metrics collector checks for and deletes old data.

          default = 60, format = int32, default = 60

        • localDataRetentionDatabaseSizeInMb integer

          The maximum size of the local database in megabytes.

          default = 500, format = int32, default = 500

    • errorMessage object
      Show errorMessage properties
      • errors array of objects
        Show errors properties
        • code string
        • title string
        • detail string
      • traceId string
      • hasErrors boolean

400

Bad request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
GET /api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.getDirectAccessAgentToolsMetricsCollectorConfiguration(
  'string',
)
qlik direct-access-agent tool metrics-collector configuration ls 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "result": {
    "connectorConfigurations": {
      "fileConnector": {
        "scrapeIntervalSeconds": 30,
        "metricsCollectionEnabled": false
      },
      "odbcConnector": {
        "scrapeIntervalSeconds": 30,
        "metricsCollectionEnabled": false
      },
      "restConnector": {
        "scrapeIntervalSeconds": 30,
        "metricsCollectionEnabled": false
      },
      "systemMetrics": {
        "scrapeIntervalSeconds": 30,
        "metricsCollectionEnabled": false
      },
      "connectorAgent": {
        "scrapeIntervalSeconds": 30,
        "metricsCollectionEnabled": false
      },
      "sapBwConnector": {
        "scrapeIntervalSeconds": 30,
        "metricsCollectionEnabled": false
      },
      "sapSqlConnector": {
        "scrapeIntervalSeconds": 30,
        "metricsCollectionEnabled": false
      },
      "sapPackageConnector": {
        "scrapeIntervalSeconds": 30,
        "metricsCollectionEnabled": false
      }
    },
    "metricsCollectorSettings": {
      "port": 5052,
      "enabled": false,
      "localDataRetentionDays": 30,
      "baseScrapeIntervalSeconds": 1,
      "localDatabaseFileLocation": "",
      "dataRetentionCheckIntervalMinutes": 60,
      "localDataRetentionDatabaseSizeInMb": 500
    }
  },
  "errorMessage": {
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "traceId": "string",
    "hasErrors": true
  }
}

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+.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • agentId string
    Required

    The agent ID.

Request Body

The contents of the file to be updated.

  • application/json object
    Show application/json properties
    • connectorConfigurations object
      Required
      Show connectorConfigurations properties
      • fileConnector object
        Required
        Show fileConnector properties
        • scrapeIntervalSeconds integer
          Required

          Frequency in seconds at which metrics are collected from this connector.

          default = 30, format = int32, default = 30

        • metricsCollectionEnabled boolean
          Required

          Indicates whether metrics collection is enabled for this connector.

          default = false

      • odbcConnector object
        Required
        Show odbcConnector properties
        • scrapeIntervalSeconds integer
          Required

          Frequency in seconds at which metrics are collected from this connector.

          default = 30, format = int32, default = 30

        • metricsCollectionEnabled boolean
          Required

          Indicates whether metrics collection is enabled for this connector.

          default = false

      • restConnector object
        Required
        Show restConnector properties
        • scrapeIntervalSeconds integer
          Required

          Frequency in seconds at which metrics are collected from this connector.

          default = 30, format = int32, default = 30

        • metricsCollectionEnabled boolean
          Required

          Indicates whether metrics collection is enabled for this connector.

          default = false

      • systemMetrics object
        Required
        Show systemMetrics properties
        • scrapeIntervalSeconds integer
          Required

          Frequency in seconds at which metrics are collected from this connector.

          default = 30, format = int32, default = 30

        • metricsCollectionEnabled boolean
          Required

          Indicates whether metrics collection is enabled for this connector.

          default = false

      • connectorAgent object
        Required
        Show connectorAgent properties
        • scrapeIntervalSeconds integer
          Required

          Frequency in seconds at which metrics are collected from this connector.

          default = 30, format = int32, default = 30

        • metricsCollectionEnabled boolean
          Required

          Indicates whether metrics collection is enabled for this connector.

          default = false

      • sapBwConnector object
        Required
        Show sapBwConnector properties
        • scrapeIntervalSeconds integer
          Required

          Frequency in seconds at which metrics are collected from this connector.

          default = 30, format = int32, default = 30

        • metricsCollectionEnabled boolean
          Required

          Indicates whether metrics collection is enabled for this connector.

          default = false

      • sapSqlConnector object
        Required
        Show sapSqlConnector properties
        • scrapeIntervalSeconds integer
          Required

          Frequency in seconds at which metrics are collected from this connector.

          default = 30, format = int32, default = 30

        • metricsCollectionEnabled boolean
          Required

          Indicates whether metrics collection is enabled for this connector.

          default = false

      • sapPackageConnector object
        Required
        Show sapPackageConnector properties
        • scrapeIntervalSeconds integer
          Required

          Frequency in seconds at which metrics are collected from this connector.

          default = 30, format = int32, default = 30

        • metricsCollectionEnabled boolean
          Required

          Indicates whether metrics collection is enabled for this connector.

          default = false

    • metricsCollectorSettings object
      Required
      Show metricsCollectorSettings properties
      • port integer
        Required

        The port number that the metrics collector API will run on. This must match the port that the SYSTEM connector runs on to enable network metrics collection.

        minimum = 1, maximum = 65535, default = 5052, format = int32, default = 5052

      • enabled boolean
        Required

        Indicates whether the metrics collector is enabled.

        default = false

      • localDataRetentionDays integer
        Required

        The number of days to retain local data.

        minimum = 1, maximum = 2147483647, default = 30, format = int32, default = 30

      • baseScrapeIntervalSeconds integer
        Required

        The base interval in seconds for the metrics collection loop. This defines how frequently the collector checks whether to scrape each connector, not the interval at which each connector is scraped. Must be equal to or less than the lowest individual connector scrape interval.

        minimum = 1, maximum = 2147483647, default = 1, format = int32, default = 1

      • localDatabaseFileLocation string
        Required

        The file location for the local metrics database. If not specified, defaults to C:\ProgramData\Qlik\Gateway\tmp.

        default = ""

      • dataRetentionCheckIntervalMinutes integer
        Required

        The interval in minutes the metrics collector checks for and deletes old data.

        minimum = 1, maximum = 2147483647, default = 60, format = int32, default = 60

      • localDataRetentionDatabaseSizeInMb integer

        The maximum size of the local database in megabytes. Default is 500 MB.

        minimum = 1, maximum = 2147483647, default = 500, format = int32, default = 500

Responses

204

Updated.

400

Bad request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

404

Configuration file not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean

409

Conflict.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
    • hasErrors boolean
PUT /api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.directAccessAgents.setDirectAccessAgentToolsMetricsCollectorConfiguration(
  'string',
  {
    connectorConfigurations: {
      connectorAgent: {
        scrapeIntervalSeconds: 30,
      },
      fileConnector: {
        scrapeIntervalSeconds: 30,
      },
      odbcConnector: {
        scrapeIntervalSeconds: 30,
      },
      restConnector: {
        scrapeIntervalSeconds: 30,
      },
      sapBwConnector: {
        scrapeIntervalSeconds: 30,
      },
      sapPackageConnector: {
        scrapeIntervalSeconds: 30,
      },
      sapSqlConnector: {
        scrapeIntervalSeconds: 30,
      },
      systemMetrics: {
        scrapeIntervalSeconds: 30,
      },
    },
    metricsCollectorSettings: {
      baseScrapeIntervalSeconds: 1,
      dataRetentionCheckIntervalMinutes: 60,
      localDataRetentionDatabaseSizeInMb: 500,
      localDataRetentionDays: 30,
      port: 5052,
    },
  },
)
qlik direct-access-agent tool metrics-collector configuration update 'string' \
  --connectorConfigurations-connectorAgent-metricsCollectionEnabled false \
  --connectorConfigurations-connectorAgent-scrapeIntervalSeconds 30 \
  --connectorConfigurations-fileConnector-metricsCollectionEnabled false \
  --connectorConfigurations-fileConnector-scrapeIntervalSeconds 30 \
  --connectorConfigurations-odbcConnector-metricsCollectionEnabled false \
  --connectorConfigurations-odbcConnector-scrapeIntervalSeconds 30 \
  --connectorConfigurations-restConnector-metricsCollectionEnabled false \
  --connectorConfigurations-restConnector-scrapeIntervalSeconds 30 \
  --connectorConfigurations-sapBwConnector-metricsCollectionEnabled false \
  --connectorConfigurations-sapBwConnector-scrapeIntervalSeconds 30 \
  --connectorConfigurations-sapPackageConnector-metricsCollectionEnabled false \
  --connectorConfigurations-sapPackageConnector-scrapeIntervalSeconds 30 \
  --connectorConfigurations-sapSqlConnector-metricsCollectionEnabled false \
  --connectorConfigurations-sapSqlConnector-scrapeIntervalSeconds 30 \
  --connectorConfigurations-systemMetrics-metricsCollectionEnabled false \
  --connectorConfigurations-systemMetrics-scrapeIntervalSeconds 30 \
  --metricsCollectorSettings-baseScrapeIntervalSeconds 1 \
  --metricsCollectorSettings-dataRetentionCheckIntervalMinutes 60 \
  --metricsCollectorSettings-enabled false \
  --metricsCollectorSettings-localDataRetentionDatabaseSizeInMb 500 \
  --metricsCollectorSettings-localDataRetentionDays 30 \
  --metricsCollectorSettings-localDatabaseFileLocation '' \
  --metricsCollectorSettings-port 5052
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"connectorConfigurations":{"fileConnector":{"scrapeIntervalSeconds":30,"metricsCollectionEnabled":false},"odbcConnector":{"scrapeIntervalSeconds":30,"metricsCollectionEnabled":false},"restConnector":{"scrapeIntervalSeconds":30,"metricsCollectionEnabled":false},"systemMetrics":{"scrapeIntervalSeconds":30,"metricsCollectionEnabled":false},"connectorAgent":{"scrapeIntervalSeconds":30,"metricsCollectionEnabled":false},"sapBwConnector":{"scrapeIntervalSeconds":30,"metricsCollectionEnabled":false},"sapSqlConnector":{"scrapeIntervalSeconds":30,"metricsCollectionEnabled":false},"sapPackageConnector":{"scrapeIntervalSeconds":30,"metricsCollectionEnabled":false}},"metricsCollectorSettings":{"port":5052,"enabled":false,"localDataRetentionDays":30,"baseScrapeIntervalSeconds":1,"localDatabaseFileLocation":"","dataRetentionCheckIntervalMinutes":60,"localDataRetentionDatabaseSizeInMb":500}}'