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

    Parameters

    • agentId: string

      The agent ID

    • agentAction: string

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

    • Optionaloptions: ApiCallOptions

    Returns Promise<RestartDirectAccessAgentHttpResponse>

    RestartDirectAccessAgentHttpError