Type Alias DirectAccessAgentsAPI

type DirectAccessAgentsAPI = {
    clearCache: typeof clearCache;
    getDirectAccessAgentConfiguration: typeof getDirectAccessAgentConfiguration;
    getDirectAccessAgentConnectorCustomDataTypeMappings: typeof getDirectAccessAgentConnectorCustomDataTypeMappings;
    getDirectAccessAgentConnectorFile: typeof getDirectAccessAgentConnectorFile;
    getDirectAccessAgentConnectorFiles: typeof getDirectAccessAgentConnectorFiles;
    getDirectAccessAgentConnectorFilesAllowedPaths: typeof getDirectAccessAgentConnectorFilesAllowedPaths;
    getDirectAccessAgentConnectorFilesWithoutQuery: typeof getDirectAccessAgentConnectorFilesWithoutQuery;
    patchDirectAccessAgentConfiguration: typeof patchDirectAccessAgentConfiguration;
    putDirectAccessAgentConnectorCustomDataTypeMappings: typeof putDirectAccessAgentConnectorCustomDataTypeMappings;
    putDirectAccessAgentConnectorFilesAllowedPaths: typeof putDirectAccessAgentConnectorFilesAllowedPaths;
    restartDirectAccessAgent: typeof restartDirectAccessAgent;
    updateDirectAccessAgentConnectorFile: typeof updateDirectAccessAgentConnectorFile;
    updateDirectAccessAgentConnectorFileWithoutQuery: typeof updateDirectAccessAgentConnectorFileWithoutQuery;
}
Index

Properties

clearCache getDirectAccessAgentConfiguration getDirectAccessAgentConnectorCustomDataTypeMappings getDirectAccessAgentConnectorFile getDirectAccessAgentConnectorFiles getDirectAccessAgentConnectorFilesAllowedPaths getDirectAccessAgentConnectorFilesWithoutQuery patchDirectAccessAgentConfiguration putDirectAccessAgentConnectorCustomDataTypeMappings putDirectAccessAgentConnectorFilesAllowedPaths restartDirectAccessAgent updateDirectAccessAgentConnectorFile updateDirectAccessAgentConnectorFileWithoutQuery

Properties

clearCache: typeof clearCache

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

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

getDirectAccessAgentConnectorCustomDataTypeMappings: typeof getDirectAccessAgentConnectorCustomDataTypeMappings

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.

The connector type. Must be odbc-connector for this endpoint.

GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError

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

getDirectAccessAgentConnectorFilesAllowedPaths: typeof getDirectAccessAgentConnectorFilesAllowedPaths

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.

The connector type. Must be file-connector for this endpoint.

GetDirectAccessAgentConnectorFilesAllowedPathsHttpError

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

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

putDirectAccessAgentConnectorCustomDataTypeMappings: typeof putDirectAccessAgentConnectorCustomDataTypeMappings

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.

The connector type. Must be odbc-connector for this endpoint.

Param: body

an object with the body content

PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError

putDirectAccessAgentConnectorFilesAllowedPaths: typeof putDirectAccessAgentConnectorFilesAllowedPaths

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.

The connector type. Must be file-connector for this endpoint.

Param: body

an object with the body content

PutDirectAccessAgentConnectorFilesAllowedPathsHttpError

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

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