v1
latestOpenAPI 3.0.02026-08-04153266.1 KBdirect-access-agent-configuration
Restart an agent
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+.
post/api/v1/direct-access-agents/{agentId}/actions/{agentAction}
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
Response
Service restarted successfully.