Type Alias DirectAccessAgentsAPI

type DirectAccessAgentsAPI = {
    clearCache: typeof clearCache;
    createDirectAccessAgentBenchmark: typeof createDirectAccessAgentBenchmark;
    createDirectAccessAgentBenchmarkCancel: typeof createDirectAccessAgentBenchmarkCancel;
    getDirectAccessAgentBenchmark: typeof getDirectAccessAgentBenchmark;
    getDirectAccessAgentConfiguration: typeof getDirectAccessAgentConfiguration;
    getDirectAccessAgentConnectorFile: typeof getDirectAccessAgentConnectorFile;
    getDirectAccessAgentConnectorFiles: typeof getDirectAccessAgentConnectorFiles;
    getDirectAccessAgentConnectorFilesWithoutQuery: typeof getDirectAccessAgentConnectorFilesWithoutQuery;
    getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths: typeof getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths;
    getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings: typeof getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings;
    getDirectAccessAgentToolsMetricsCollectorConfiguration: typeof getDirectAccessAgentToolsMetricsCollectorConfiguration;
    patchDirectAccessAgentConfiguration: typeof patchDirectAccessAgentConfiguration;
    putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths: typeof putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths;
    putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings: typeof putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings;
    restartDirectAccessAgent: typeof restartDirectAccessAgent;
    setDirectAccessAgentToolsMetricsCollectorConfiguration: typeof setDirectAccessAgentToolsMetricsCollectorConfiguration;
    updateDirectAccessAgentConnectorFile: typeof updateDirectAccessAgentConnectorFile;
    updateDirectAccessAgentConnectorFileWithoutQuery: typeof updateDirectAccessAgentConnectorFileWithoutQuery;
}
Index
clearCache createDirectAccessAgentBenchmark createDirectAccessAgentBenchmarkCancel getDirectAccessAgentBenchmark getDirectAccessAgentConfiguration getDirectAccessAgentConnectorFile getDirectAccessAgentConnectorFiles getDirectAccessAgentConnectorFilesWithoutQuery getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings getDirectAccessAgentToolsMetricsCollectorConfiguration patchDirectAccessAgentConfiguration putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings restartDirectAccessAgent setDirectAccessAgentToolsMetricsCollectorConfiguration updateDirectAccessAgentConnectorFile updateDirectAccessAgentConnectorFileWithoutQuery
clearCache: typeof clearCache

Clears the cache for direct-access-agents api requests.

createDirectAccessAgentBenchmark: typeof createDirectAccessAgentBenchmark

Starts a background benchmark task that measures the throughput and latency of a Direct Access agent. Use the returned benchmarkId to monitor progress and retrieve performance metrics for capacity planning or performance optimization. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.8+.

The agent ID

an object with query parameters

CreateDirectAccessAgentBenchmarkHttpError

createDirectAccessAgentBenchmarkCancel: typeof createDirectAccessAgentBenchmarkCancel

Requests cancellation of a running benchmark for the specified agent. The request is asynchronous. Use the returned status URL to monitor when cancellation completes. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.8+.

The agent ID

The benchmark ID

CreateDirectAccessAgentBenchmarkCancelHttpError

getDirectAccessAgentBenchmark: typeof getDirectAccessAgentBenchmark

Retrieves the current status, progress, and performance metrics for a benchmark task. Use this operation to monitor a running benchmark or inspect its completed results. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.8+.

The agent ID

The benchmark ID

GetDirectAccessAgentBenchmarkHttpError

getDirectAccessAgentConfiguration: typeof getDirectAccessAgentConfiguration

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

The agent ID

an object with query parameters

GetDirectAccessAgentConfigurationHttpError

getDirectAccessAgentConnectorFile: typeof getDirectAccessAgentConnectorFile

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

The agent ID

The connector type to retrieve

The type of file to retrieve

GetDirectAccessAgentConnectorFileHttpError

getDirectAccessAgentConnectorFiles: typeof getDirectAccessAgentConnectorFiles

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

The agent ID

The connector to retrieve the list of files for

an object with query parameters

GetDirectAccessAgentConnectorFilesHttpError

getDirectAccessAgentConnectorFilesWithoutQuery: typeof getDirectAccessAgentConnectorFilesWithoutQuery

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

The agent ID

The connector to retrieve the list of files for

GetDirectAccessAgentConnectorFilesWithoutQueryHttpError

getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths: typeof getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths

Retrieves the allowed paths settings for the File Connector. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.6+.

The agent ID

GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError

getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings: typeof getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings

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

The agent ID.

GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError

getDirectAccessAgentToolsMetricsCollectorConfiguration: typeof getDirectAccessAgentToolsMetricsCollectorConfiguration

Retrieves the settings for the metrics collector. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.9+.

The agent ID.

GetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError

patchDirectAccessAgentConfiguration: typeof patchDirectAccessAgentConfiguration

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

The agent ID

Param: body

an object with the body content

PatchDirectAccessAgentConfigurationHttpError

putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths: typeof putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths

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

The agent id

Param: body

an object with the body content

PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError

putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings: typeof putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings

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

The agent ID.

Param: body

an object with the body content

PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError

restartDirectAccessAgent: typeof restartDirectAccessAgent

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

The agent ID

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

RestartDirectAccessAgentHttpError

setDirectAccessAgentToolsMetricsCollectorConfiguration: typeof setDirectAccessAgentToolsMetricsCollectorConfiguration

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

The agent ID.

Param: body

an object with the body content

SetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError

updateDirectAccessAgentConnectorFile: typeof updateDirectAccessAgentConnectorFile

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

The agent ID

The connector type to update

The file type to update

an object with query parameters

Param: body

an object with the body content

UpdateDirectAccessAgentConnectorFileHttpError

updateDirectAccessAgentConnectorFileWithoutQuery: typeof updateDirectAccessAgentConnectorFileWithoutQuery

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

The agent ID

The connector type to update

The file type to update

Param: body

an object with the body content

UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError

Settings
Member Visibility

On This Page
Properties