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

POST

/v1/direct-access-agents/{agentId}/actions/{agentAction}
GET

/v1/direct-access-agents/{agentId}/configurations
PATCH

/v1/direct-access-agents/{agentId}/configurations
GET

/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files
GET

/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}
PUT

/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}

Restarts the specified agent. If a reload is in RELOADING status, the restart action will be ignored, but force-restart will restart the agent even if a reload is in RELOADING status. Requestor must be assigned the TenantAdmin 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

application/json

Error restarting the service.

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

403

application/json

Non-Windows operating system.

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

404

application/json

Service doesn't exist.

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

POST /v1/direct-access-agents/{agentId}/actions/{agentAction}

curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/actions/{agentAction}" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/actions/{agentAction}',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Retrieves the connector agent configuration from the specified agent. Requestor must be assigned the TenantAdmin 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

application/json

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

404

application/json

Configuration file not found.

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

GET /v1/direct-access-agents/{agentId}/configurations

curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/configurations" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/configurations',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

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
    }
  ]
}

Makes changes to the local agent configuration using JSON Patch. Requestor must be assigned the TenantAdmin 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

application/json

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"
- valuestring
  Required

application/json-patch+json

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"
- valuestring
  Required

Responses

204

Patch applied.

207

application/json

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"
  
  valuestring
  Required
  
  validationResultstring
- errorMessagestring
- httpStatusCodeinteger
  
  format = int32
- failedPatchErrorobject
  
  Show failedPatchError properties
  
  errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  traceIdstring
  
  hasErrorsboolean

400

application/json

Bad request.

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

404

application/json

Configuration file not found.

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

415

application/json

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 /v1/direct-access-agents/{agentId}/configurations

curl "https://your-tenant.us.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"}]'

const https = require('https')
  const data = JSON.stringify([{"op":"add","path":"AGENT_LOG_LEVEL","value":"string"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/configurations',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

[
  {
    "op": "add",
    "path": "AGENT_LOG_LEVEL",
    "value": "string"
  }
]

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
  }
}

Retrieves the configuration files associated with the connector. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.3+.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Query Parameters

connectorTypestring

The connector to retrieve the list of files for

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

Path Parameters

agentIdstring
Required

The gateway ID

Responses

200

application/json

The list of files for the specified connector.

application/jsonobject
Show application/json properties
- resultarray of strings
  
  The list of configuration items from the connector's configuration file.
- errorMessageobject
  
  Show errorMessage properties
  
  errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  traceIdstring
  
  hasErrorsboolean

404

application/json

Configuration file not found.

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

GET /v1/direct-access-agents/{agentId}/connectors/{connectorType}/files

curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

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

Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.3+.

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

Responses

200

application/json

The list of configuration values from the file.

application/jsonobject
Show application/json properties
- resultarray of strings
  
  The list of configuration items from the connector's configuration file.
- errorMessageobject
  
  Show errorMessage properties
  
  errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  traceIdstring
  
  hasErrorsboolean

404

application/json

Configuration file not found.

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

GET /v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}

curl "https://your-tenant.us.qlikcloud.com/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

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

Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.3+.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Query Parameters

connectorTypestring

The connector type to update

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

Path Parameters

agentIdstring
Required

The agent id
fileTypestring
Required

The file type to update

Request Body

application/json

The contents of the file to be updated

The request to update a connector flat file

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

application/json

Bad request.

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

404

application/json

Configuration file not found.

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

409

application/json

Conflict.

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

PUT /v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}

curl "https://your-tenant.us.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"]}'

const https = require('https')
  const data = JSON.stringify({"contentsToSave":["C:\\\\filepath"]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "contentsToSave": [
    "C:\\\\filepath"
  ]
}

Direct Access Agents

Endpoints

Restart an agent

Facts

Path Parameters

Responses

204

400

403

404

Get agent configuration

Facts

Query Parameters

Path Parameters

Responses

200

404

Response

Update agent configuration

Facts

Path Parameters

Request Body

Responses

204

207

400

404

415

Request

Response

Get connector configuration files

Facts

Query Parameters

Path Parameters

Responses

200

404

Response

Get connector configuration

Facts

Path Parameters

Responses

200

404

Response

Set connector configuration

Facts

Query Parameters

Path Parameters

Request Body

Responses

204

400

404

409

Request