Delete a Single Agent by Name
delete
/serviceapi/agentlifecycle/delete/{agenttype}/name/{agentname}
Delete the selected agent.
Values:
- gateway
- cloudagent
- datacollector
Request
Path Parameters
-
agentname: string
The name of the agent. This should be actual agent name and not display name. The name will be in form of host:port.
-
agenttype: string
The type of the agent. The value is case-insensitive. Values: gateway | cloudagent | datacollector
Response
Supported Media Types
- application/json
200 Response
Agent upgrade accepted.
400 Response
Bad Request.
404 Response
Not Found - Agent not available in database
409 Response
Conflict - Entity upgrade already in progress.
412 Response
Pre-condition failed - Pre-requisite checks failed
500 Response
Internal Server Error - Unexpected exception occured