Direct Access Agents

Download specification

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

Path Parameters

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

  • agentIdstring
    Required

    The agent ID

Responses

204

Service restarted successfully.

400

Error restarting the service.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

403

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Service doesn't exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

409

Conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
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',
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/actions/{agentAction}" \
-X POST \
-H "Authorization: Bearer <access_token>"

Start agent benchmark

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

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Query Parameters

  • forceboolean

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

    default = false

  • gigaBytesToTransferinteger

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

    default = 1, format = int32, default = 1

Path Parameters

  • agentIdstring
    Required

    The agent ID

Responses

201

Benchmark task created successfully with a unique identifier.

  • application/jsonobject
    Show application/json properties
    • benchmarkIdstring

403

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

The agent was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

500

There was an error processing the request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

501

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

503

Service is unavailable.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
POST /api/v1/direct-access-agents/{agentId}/benchmarks 
// qlik-api has not implemented support for `POST /api/v1/direct-access-agents/{agentId}/benchmarks` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/direct-access-agents/{agentId}/benchmarks',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
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 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+.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

  • benchmarkIdstring
    Required

    The benchmark ID

Responses

200

Benchmark status and performance metrics retrieved successfully.

  • application/jsonobject
    Show application/json properties
    • statusstring

      The benchmark status

    • resultsobject
      Show results properties
      • latencyinteger

        The latency in ms measured during data transmission

        format = int64

      • throughputinteger

        The data throughput in KB/s measured during data transmission

        format = int64

      • totalBytesTransferredinteger

        The total number of bytes successfully transferred during data transmission

        format = int64

      • dataTransmissionEndTimestring

        The ISO 8601 formatted timestamp when data transmission completed

      • dataTransmissionStartTimestring

        The ISO 8601 formatted timestamp when data transmission start
    • benchmarkIdstring

      The benchmark ID

    • statusMessagestring

      Additional details about the benchmark status

    • benchmarkEndTimestring

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

    • benchmarkStartTimestring

      The ISO 8601 formatted timestamp when the benchmark task started execution

    • totalBytesRequestedinteger

      The total bytes requested to be transferred during the benchmark

      format = int64

403

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

The benchmark was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

500

There was an error processing the request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

503

Service is unavailable.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
GET /api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId} 
// qlik-api has not implemented support for `GET /api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "status": "string",
  "results": {
    "latency": 42,
    "throughput": 42,
    "totalBytesTransferred": 42,
    "dataTransmissionEndTime": "string",
    "dataTransmissionStartTime": "string"
  },
  "benchmarkId": "string",
  "statusMessage": "string",
  "benchmarkEndTime": "string",
  "benchmarkStartTime": "string",
  "totalBytesRequested": 42
}

Requests a cancellation on a running benchmark

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

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

  • benchmarkIdstring
    Required

    The benchmark ID

Responses

202

The cancellation was requested successfully.

  • application/jsonobject
    Show application/json properties
    • messagestring
    • statusUrlobject
      Show statusUrl properties
      • hrefstring

        The URL to the related resource

403

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

The benchmark was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

500

There was an error processing the request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

503

Service is unavailable.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
POST /api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}/cancel 
// qlik-api has not implemented support for `POST /api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}/cancel` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/direct-access-agents/{agentId}/benchmarks/{benchmarkId}/cancel',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
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)
Categories

Query Parameters

  • queryPropertiesarray of strings

    Individual properties within the agent configuration

Path Parameters

  • agentIdstring
    Required

    The agent ID

Responses

200

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

  • application/jsonobject
    Show application/json properties
    • connectorsarray of objects
      Show connectors properties
      • settingsarray of objects
        One of:
        • ConfigurationLineNumericobject
          Show ConfigurationLineNumeric properties
          • namestring
          • valuestring
          • connectorstring
          • uiActionsarray of strings

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

          • apiActionsarray of strings

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

          • descriptionstring
          • displayNamestring
          • defaultValuestring
          • pendingValuestring
          • permittedRangeEndinteger

            format = int32

          • pendingApplicationboolean
          • allowMultipleValuesboolean
          • applyWithoutRestartboolean
          • permittedRangeStartinteger

            format = int32

        • ConfigurationLineStringobject
          Show ConfigurationLineString properties
          • namestring
          • valuestring
          • connectorstring
          • uiActionsarray of strings

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

          • apiActionsarray of strings

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

          • descriptionstring
          • displayNamestring
          • defaultValuestring
          • pendingValuestring
          • permittedValuesarray of strings
          • pendingApplicationboolean
          • allowMultipleValuesboolean
          • applyWithoutRestartboolean
      • connectorNamestring
    • dcaasSettingsarray of objects
      One of:
      • ConfigurationLineNumericobject
        Show ConfigurationLineNumeric properties
        • namestring
        • valuestring
        • connectorstring
        • uiActionsarray of strings

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

        • apiActionsarray of strings

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

        • descriptionstring
        • displayNamestring
        • defaultValuestring
        • pendingValuestring
        • permittedRangeEndinteger

          format = int32

        • pendingApplicationboolean
        • allowMultipleValuesboolean
        • applyWithoutRestartboolean
        • permittedRangeStartinteger

          format = int32

      • ConfigurationLineStringobject
        Show ConfigurationLineString properties
        • namestring
        • valuestring
        • connectorstring
        • uiActionsarray of strings

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

        • apiActionsarray of strings

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

        • descriptionstring
        • displayNamestring
        • defaultValuestring
        • pendingValuestring
        • permittedValuesarray of strings
        • pendingApplicationboolean
        • allowMultipleValuesboolean
        • applyWithoutRestartboolean
    • connectorAgentSettingsarray of objects
      One of:
      • ConfigurationLineNumericobject
        Show ConfigurationLineNumeric properties
        • namestring
        • valuestring
        • connectorstring
        • uiActionsarray of strings

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

        • apiActionsarray of strings

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

        • descriptionstring
        • displayNamestring
        • defaultValuestring
        • pendingValuestring
        • permittedRangeEndinteger

          format = int32

        • pendingApplicationboolean
        • allowMultipleValuesboolean
        • applyWithoutRestartboolean
        • permittedRangeStartinteger

          format = int32

      • ConfigurationLineStringobject
        Show ConfigurationLineString properties
        • namestring
        • valuestring
        • connectorstring
        • uiActionsarray of strings

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

        • apiActionsarray of strings

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

        • descriptionstring
        • displayNamestring
        • defaultValuestring
        • pendingValuestring
        • permittedValuesarray of strings
        • pendingApplicationboolean
        • allowMultipleValuesboolean
        • applyWithoutRestartboolean

403

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
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',
  {},
)
This API is not included yet in qlik-cli
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",
          "permittedRangeEnd": 42,
          "pendingApplication": true,
          "allowMultipleValues": true,
          "applyWithoutRestart": true,
          "permittedRangeStart": 42
        }
      ],
      "connectorName": "string"
    }
  ],
  "dcaasSettings": [
    {
      "name": "string",
      "value": "string",
      "connector": "string",
      "uiActions": [
        "Read"
      ],
      "apiActions": [
        "Read"
      ],
      "description": "string",
      "displayName": "string",
      "defaultValue": "string",
      "pendingValue": "string",
      "permittedRangeEnd": 42,
      "pendingApplication": true,
      "allowMultipleValues": true,
      "applyWithoutRestart": true,
      "permittedRangeStart": 42
    }
  ],
  "connectorAgentSettings": [
    {
      "name": "string",
      "value": "string",
      "connector": "string",
      "uiActions": [
        "Read"
      ],
      "apiActions": [
        "Read"
      ],
      "description": "string",
      "displayName": "string",
      "defaultValue": "string",
      "pendingValue": "string",
      "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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

Request Body

The JSON Patch document

  • application/jsonarray of objects
    Show application/json properties
    • opstring
      Required

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

    • pathstring
      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"

    • valuestring
      Required

The JSON Patch document

  • application/json-patch+jsonarray of objects
    Show application/json-patch+json properties
    • opstring
      Required

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

    • pathstring
      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"

    • valuestring
      Required

Responses

204

Patch applied.

207

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

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • validboolean
      • operationobject
        Show operation properties
        • opstring
          Required

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

        • pathstring
          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"

        • valuestring
          Required
      • validationResultstring
    • errorMessagestring
    • httpStatusCodeinteger

      format = int32

    • failedPatchErrorobject
      Show failedPatchError properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

400

Bad request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

403

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

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/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
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',
    },
  ],
)
This API is not included yet in qlik-cli
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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

  • connectorTypestring
    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/jsonobject
    Show application/json properties
    • resultarray of strings
    • errorMessageobject
      Show errorMessage properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

403

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
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',
)
This API is not included yet in qlik-cli
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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

  • connectorTypestring
    Required

    The connector type to retrieve

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

  • fileTypestring
    Required

    The type of file to retrieve

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

Responses

200

The list of configuration values from the file.

  • application/jsonobject
    Show application/json properties
    • resultarray of strings
    • errorMessageobject
      Show errorMessage properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

403

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
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',
)
This API is not included yet in qlik-cli
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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

  • connectorTypestring
    Required

    The connector type to update

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

  • fileTypestring
    Required

    The file type to update

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

Request Body

The contents of the file to be updated

  • application/jsonobject

    The request to update a connector flat file

    Show application/json properties
    • contentsToSavearray of strings

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

Responses

204

Updated.

400

Bad request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

409

Conflict.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
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'] },
)
This API is not included yet in qlik-cli
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 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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID

Responses

200

The list of configuration values from the file.

  • application/jsonobject
    Show application/json properties
    • resultarray of objects
      Show result properties
      • pathstring
        Required

        The Path property in the File connector allowed paths file.

        minLength = 1

      • spacesarray of strings

        The Spaces property in the Odbc custom type mappings file.
    • errorMessageobject
      Show errorMessage properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
GET /api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths 
// qlik-api has not implemented support for `GET /api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
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 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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent id

Request Body

The contents of the file to be updated

  • application/jsonobject
    Show application/json properties
    • fileConnectorAllowedPathsarray of objects
      Show fileConnectorAllowedPaths properties
      • pathstring
        Required

        The Path property in the File connector allowed paths file.

        minLength = 1

      • spacesarray of strings

        The Spaces property in the Odbc custom type mappings file.

Responses

204

Updated.

400

Bad request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

409

Conflict.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
PUT /api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths 
// qlik-api has not implemented support for `PUT /api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths',
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      fileConnectorAllowedPaths: [
        {
          path: '\\\\\\\\Server\\\\Share\\\\example',
          spaces: ['Foo', 'Bar'],
        },
      ],
    }),
  },
)
This API is not included yet in qlik-cli
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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID.

Responses

200

The list of configuration values from the file.

  • application/jsonobject
    Show application/json properties
    • resultarray of objects
      Show result properties
      • idstring
        Required

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

        minLength = 1

      • bitboolean

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

      • sizeinteger

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

        default = 0, format = int32, default = 0

      • qlikDataTypestring
        Required

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

        minLength = 1

      • nativeDataTypestring
        Required

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

        minLength = 1

    • errorMessageobject
      Show errorMessage properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
GET /api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings 
// qlik-api has not implemented support for `GET /api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID.

Request Body

The contents of the file to be updated.

  • application/jsonobject
    Show application/json properties
    • odbcCustomDataTypesarray of objects
      Show odbcCustomDataTypes properties
      • idstring
        Required

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

        minLength = 1

      • bitboolean

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

      • sizeinteger

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

        default = 0, format = int32, default = 0

      • qlikDataTypestring
        Required

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

        minLength = 1

      • nativeDataTypestring
        Required

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

        minLength = 1

Responses

204

Updated.

400

Bad request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

409

Conflict.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
PUT /api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings 
// qlik-api has not implemented support for `PUT /api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings',
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      odbcCustomDataTypes: [
        {
          id: 'Amazon Athena ODBC (x64)',
          bit: true,
          size: 0,
          qlikDataType: 'String',
          nativeDataType: 'varchar',
        },
      ],
    }),
  },
)
This API is not included yet in qlik-cli
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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID.

Responses

200

The list of configuration values from the file.

  • application/jsonobject
    Show application/json properties
    • resultobject
      Show result properties
      • connectorConfigurationsobject
        Show connectorConfigurations properties
        • fileConnectorobject
          Show fileConnector properties
          • scrapeIntervalSecondsinteger
            Required

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

            format = int32

          • metricsCollectionEnabledboolean
            Required

            Indicates whether metrics collection is enabled for this connector.
        • odbcConnectorobject
          Show odbcConnector properties
          • scrapeIntervalSecondsinteger
            Required

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

            format = int32

          • metricsCollectionEnabledboolean
            Required

            Indicates whether metrics collection is enabled for this connector.
        • restConnectorobject
          Show restConnector properties
          • scrapeIntervalSecondsinteger
            Required

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

            format = int32

          • metricsCollectionEnabledboolean
            Required

            Indicates whether metrics collection is enabled for this connector.
        • systemMetricsobject
          Show systemMetrics properties
          • scrapeIntervalSecondsinteger
            Required

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

            format = int32

          • metricsCollectionEnabledboolean
            Required

            Indicates whether metrics collection is enabled for this connector.
        • connectorAgentobject
          Show connectorAgent properties
          • scrapeIntervalSecondsinteger
            Required

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

            format = int32

          • metricsCollectionEnabledboolean
            Required

            Indicates whether metrics collection is enabled for this connector.
        • sapBwConnectorobject
          Show sapBwConnector properties
          • scrapeIntervalSecondsinteger
            Required

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

            format = int32

          • metricsCollectionEnabledboolean
            Required

            Indicates whether metrics collection is enabled for this connector.
        • sapSqlConnectorobject
          Show sapSqlConnector properties
          • scrapeIntervalSecondsinteger
            Required

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

            format = int32

          • metricsCollectionEnabledboolean
            Required

            Indicates whether metrics collection is enabled for this connector.
        • sapPackageConnectorobject
          Show sapPackageConnector properties
          • scrapeIntervalSecondsinteger
            Required

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

            format = int32

          • metricsCollectionEnabledboolean
            Required

            Indicates whether metrics collection is enabled for this connector.
      • metricsCollectorSettingsobject
        Show metricsCollectorSettings properties
        • portinteger
          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.

          format = int32

        • enabledboolean
          Required

          Indicates whether the metrics collector is enabled.

        • localDataRetentionDaysinteger
          Required

          The number of days to retain local data.

          format = int32

        • baseScrapeIntervalSecondsinteger
          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.

          format = int32

        • localDatabaseFileLocationstring

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

        • dataRetentionCheckIntervalMinutesinteger
          Required

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

          format = int32

    • errorMessageobject
      Show errorMessage properties
      • errorsarray of objects
        Show errors properties
        • codestring
        • titlestring
        • detailstring
      • traceIdstring
      • hasErrorsboolean

400

Bad request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
GET /api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration 
// qlik-api has not implemented support for `GET /api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
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": 42,
        "metricsCollectionEnabled": true
      },
      "odbcConnector": {
        "scrapeIntervalSeconds": 42,
        "metricsCollectionEnabled": true
      },
      "restConnector": {
        "scrapeIntervalSeconds": 42,
        "metricsCollectionEnabled": true
      },
      "systemMetrics": {
        "scrapeIntervalSeconds": 42,
        "metricsCollectionEnabled": true
      },
      "connectorAgent": {
        "scrapeIntervalSeconds": 42,
        "metricsCollectionEnabled": true
      },
      "sapBwConnector": {
        "scrapeIntervalSeconds": 42,
        "metricsCollectionEnabled": true
      },
      "sapSqlConnector": {
        "scrapeIntervalSeconds": 42,
        "metricsCollectionEnabled": true
      },
      "sapPackageConnector": {
        "scrapeIntervalSeconds": 42,
        "metricsCollectionEnabled": true
      }
    },
    "metricsCollectorSettings": {
      "port": 42,
      "enabled": true,
      "localDataRetentionDays": 42,
      "baseScrapeIntervalSeconds": 42,
      "localDatabaseFileLocation": "string",
      "dataRetentionCheckIntervalMinutes": 42
    }
  },
  "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)
Categories

Path Parameters

  • agentIdstring
    Required

    The agent ID.

Request Body

The contents of the file to be updated.

  • application/jsonobject
    Show application/json properties
    • connectorConfigurationsobject
      Required
      Show connectorConfigurations properties
      • fileConnectorobject
        Required
        Show fileConnector properties
        • scrapeIntervalSecondsinteger
          Required

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

          format = int32

        • metricsCollectionEnabledboolean
          Required

          Indicates whether metrics collection is enabled for this connector.
      • odbcConnectorobject
        Required
        Show odbcConnector properties
        • scrapeIntervalSecondsinteger
          Required

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

          format = int32

        • metricsCollectionEnabledboolean
          Required

          Indicates whether metrics collection is enabled for this connector.
      • restConnectorobject
        Required
        Show restConnector properties
        • scrapeIntervalSecondsinteger
          Required

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

          format = int32

        • metricsCollectionEnabledboolean
          Required

          Indicates whether metrics collection is enabled for this connector.
      • systemMetricsobject
        Required
        Show systemMetrics properties
        • scrapeIntervalSecondsinteger
          Required

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

          format = int32

        • metricsCollectionEnabledboolean
          Required

          Indicates whether metrics collection is enabled for this connector.
      • connectorAgentobject
        Required
        Show connectorAgent properties
        • scrapeIntervalSecondsinteger
          Required

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

          format = int32

        • metricsCollectionEnabledboolean
          Required

          Indicates whether metrics collection is enabled for this connector.
      • sapBwConnectorobject
        Required
        Show sapBwConnector properties
        • scrapeIntervalSecondsinteger
          Required

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

          format = int32

        • metricsCollectionEnabledboolean
          Required

          Indicates whether metrics collection is enabled for this connector.
      • sapSqlConnectorobject
        Required
        Show sapSqlConnector properties
        • scrapeIntervalSecondsinteger
          Required

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

          format = int32

        • metricsCollectionEnabledboolean
          Required

          Indicates whether metrics collection is enabled for this connector.
      • sapPackageConnectorobject
        Required
        Show sapPackageConnector properties
        • scrapeIntervalSecondsinteger
          Required

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

          format = int32

        • metricsCollectionEnabledboolean
          Required

          Indicates whether metrics collection is enabled for this connector.
    • metricsCollectorSettingsobject
      Required
      Show metricsCollectorSettings properties
      • portinteger
        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, format = int32

      • enabledboolean
        Required

        Indicates whether the metrics collector is enabled.

      • localDataRetentionDaysinteger
        Required

        The number of days to retain local data.

        minimum = 1, maximum = 2147483647, format = int32

      • baseScrapeIntervalSecondsinteger
        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, format = int32

      • localDatabaseFileLocationstring
        Required

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

      • dataRetentionCheckIntervalMinutesinteger
        Required

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

        minimum = 1, maximum = 2147483647, format = int32

Responses

204

Updated.

400

Bad request.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean

404

Configuration file not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
    • hasErrorsboolean
PUT /api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration 
// qlik-api has not implemented support for `PUT /api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration',
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      connectorConfigurations: {
        fileConnector: {
          scrapeIntervalSeconds: 42,
          metricsCollectionEnabled: true,
        },
        odbcConnector: {
          scrapeIntervalSeconds: 42,
          metricsCollectionEnabled: true,
        },
        restConnector: {
          scrapeIntervalSeconds: 42,
          metricsCollectionEnabled: true,
        },
        systemMetrics: {
          scrapeIntervalSeconds: 42,
          metricsCollectionEnabled: true,
        },
        connectorAgent: {
          scrapeIntervalSeconds: 42,
          metricsCollectionEnabled: true,
        },
        sapBwConnector: {
          scrapeIntervalSeconds: 42,
          metricsCollectionEnabled: true,
        },
        sapSqlConnector: {
          scrapeIntervalSeconds: 42,
          metricsCollectionEnabled: true,
        },
        sapPackageConnector: {
          scrapeIntervalSeconds: 42,
          metricsCollectionEnabled: true,
        },
      },
      metricsCollectorSettings: {
        port: 1,
        enabled: true,
        localDataRetentionDays: 1,
        baseScrapeIntervalSeconds: 1,
        localDatabaseFileLocation: 'string',
        dataRetentionCheckIntervalMinutes: 1,
      },
    }),
  },
)
This API is not included yet in qlik-cli
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":42,"metricsCollectionEnabled":true},"odbcConnector":{"scrapeIntervalSeconds":42,"metricsCollectionEnabled":true},"restConnector":{"scrapeIntervalSeconds":42,"metricsCollectionEnabled":true},"systemMetrics":{"scrapeIntervalSeconds":42,"metricsCollectionEnabled":true},"connectorAgent":{"scrapeIntervalSeconds":42,"metricsCollectionEnabled":true},"sapBwConnector":{"scrapeIntervalSeconds":42,"metricsCollectionEnabled":true},"sapSqlConnector":{"scrapeIntervalSeconds":42,"metricsCollectionEnabled":true},"sapPackageConnector":{"scrapeIntervalSeconds":42,"metricsCollectionEnabled":true}},"metricsCollectorSettings":{"port":1,"enabled":true,"localDataRetentionDays":1,"baseScrapeIntervalSeconds":1,"localDatabaseFileLocation":"string","dataRetentionCheckIntervalMinutes":1}}'