Qlik Sense · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for direct-access-agents Direct Access Agent Configuration API

13 actions 13 updates phrasing extends openapi/qliksense-direct-access-agent-configuration-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Qlik Sense's API. It is a proposal applied on top of the contract, not a document Qlik Sense publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/api/v1/direct-access-agents/{agentId}/actions/{agentAction}'].post
$.paths['/api/v1/direct-access-agents/{agentId}/configurations'].get
$.paths['/api/v1/direct-access-agents/{agentId}/configurations'].patch
$.paths['/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files'].get
$.paths['/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}'].get
$.paths['/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}'].put
$.paths['/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths'].get
$.paths['/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths'].put
$.paths['/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings'].get
$.paths['/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings'].put
$.paths['/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration'].get
$.paths['/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration'].put

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for direct-access-agents Direct Access Agent Configuration API
  version: 1.0.0
extends: openapi/qliksense-direct-access-agent-configuration-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/api/v1/direct-access-agents/{agentId}/actions/{agentAction}'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart a Direct Access Gateway agent
      effect: write
      questions:
      - How do I restart a Direct Access Gateway agent remotely?
      - Can I force an agent restart even while a reload is still RELOADING?
      instructions:
      - text: Run the {agentAction} action on agent {agentId}.
        slots:
          agentAction: path.agentAction
          agentId: path.agentId
      - text: Force-restart gateway agent {agentId} using action {agentAction}.
        slots:
          agentId: path.agentId
          agentAction: path.agentAction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a gateway agent configuration
      effect: read
      questions:
      - Where can I read the local configuration of a Direct Access Gateway agent?
      - Can I fetch only certain properties of an agent's configuration?
      instructions:
      - text: Show the configuration of agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Get the {queryProperties} properties from agent {agentId}'s configuration.
        slots:
          queryProperties: query.queryProperties
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/configurations'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a gateway agent configuration
      effect: write
      questions:
      - How do I change a setting in a gateway agent's local configuration with JSON Patch?
      - Can I edit just one property of the agent configuration without replacing it all?
      instructions:
      - text: Apply a JSON Patch to the configuration of agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Update the local agent configuration on {agentId}.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List a connector's configuration files
      effect: read
      questions:
      - Which configuration files does a given connector have on a gateway agent?
      - What config files exist for a connector type on my Direct Access agent?
      instructions:
      - text: List the configuration files for connector {connectorType} on agent {agentId}.
        slots:
          connectorType: path.connectorType
          agentId: path.agentId
      - text: 'Which config files does connector {connectorType} have on gateway agent {agentId}: list them.'
        slots:
          connectorType: path.connectorType
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a connector configuration file
      effect: read
      questions:
      - How can I read the items inside a connector's flat configuration file?
      - What settings are in a specific config file for a connector on the gateway?
      instructions:
      - text: Show the contents of file {fileType} for connector {connectorType} on agent {agentId}.
        slots:
          fileType: path.fileType
          connectorType: path.connectorType
          agentId: path.agentId
      - text: Read the {fileType} flat file settings of connector {connectorType} on gateway agent {agentId}.
        slots:
          fileType: path.fileType
          connectorType: path.connectorType
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/{fileType}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a connector configuration file
      effect: write
      questions:
      - How do I overwrite a connector's flat configuration file on the gateway agent?
      - Does saving a connector config file replace the whole file or merge changes?
      instructions:
      - text: Replace config file {fileType} for connector {connectorType} on agent {agentId} with {contentsToSave}.
        slots:
          fileType: path.fileType
          connectorType: path.connectorType
          agentId: path.agentId
          contentsToSave: requestBody.contentsToSave
      - text: Overwrite the {fileType} file of connector {connectorType} on agent {agentId}.
        slots:
          fileType: path.fileType
          connectorType: path.connectorType
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths'].get
  update:
    x-apievangelist-phrasing:
      intent: Get File Connector allowed paths
      effect: read
      questions:
      - Which folders is the File Connector allowed to read on my gateway agent?
      - How can I check the allowed paths set for the File Connector?
      instructions:
      - text: Show the File Connector allowed paths on agent {agentId}.
        slots:
          agentId: path.agentId
      - text: 'Which folders can the File Connector read on agent {agentId}: show them.'
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/connectors/file-connector/files/allowed-paths'].put
  update:
    x-apievangelist-phrasing:
      intent: Set File Connector allowed paths
      effect: write
      questions:
      - How do I change which paths the File Connector may access?
      - Can I add a new allowed folder for the File Connector on a gateway?
      instructions:
      - text: Set the File Connector allowed paths on agent {agentId} to {fileConnectorAllowedPaths}.
        slots:
          agentId: path.agentId
          fileConnectorAllowedPaths: requestBody.fileConnectorAllowedPaths
      - text: Replace the File Connector allowed folders on gateway agent {agentId}.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get ODBC custom data type mappings
      effect: read
      questions:
      - What custom data type mappings are configured for the Generic ODBC Connector?
      - Where can I see how ODBC column types are mapped on a gateway agent?
      instructions:
      - text: Show the Generic ODBC custom data type mappings on agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Read how ODBC column types are mapped on gateway agent {agentId}.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/connectors/odbc-connector/files/custom-data-type-mappings'].put
  update:
    x-apievangelist-phrasing:
      intent: Set ODBC custom data type mappings
      effect: write
      questions:
      - How do I define custom data type mappings for the Generic ODBC Connector?
      - Does updating ODBC type mappings replace the entire mapping file?
      instructions:
      - text: Replace the ODBC custom data type mappings on agent {agentId} with {odbcCustomDataTypes}.
        slots:
          agentId: path.agentId
          odbcCustomDataTypes: requestBody.odbcCustomDataTypes
      - text: Set new Generic ODBC type mappings on gateway agent {agentId}.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics collector settings
      effect: read
      questions:
      - What are the current metrics collector settings on a gateway agent?
      - Is the metrics collector configured on my Direct Access agent?
      instructions:
      - text: Show the metrics collector settings for agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Check whether the metrics collector is configured on gateway agent {agentId}.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/direct-access-agents/{agentId}/tools/metrics-collector/configuration'].put
  update:
    x-apievangelist-phrasing:
      intent: Set metrics collector settings
      effect: write
      questions:
      - How do I configure the metrics collector on a Direct Access Gateway agent?
      - Can I choose which connectors the metrics collector gathers data for?
      instructions:
      - text: Set metrics collector settings on agent {agentId} to {metricsCollectorSettings} for connectors {connectorConfigurations}.
        slots:
          agentId: path.agentId
          metricsCollectorSettings: requestBody.metricsCollectorSettings
          connectorConfigurations: requestBody.connectorConfigurations
      - text: Configure the metrics collector on gateway agent {agentId} with {metricsCollectorSettings} and {connectorConfigurations}.
        slots:
          agentId: path.agentId
          metricsCollectorSettings: requestBody.metricsCollectorSettings
          connectorConfigurations: requestBody.connectorConfigurations
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/qliksense-direct-access-agent-configuration-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.