Deleting a Remote Agent

Use this API to delete a remote agent from the eG manager.

URL: http://<eG manager IP:port>/api/eg/orchestration/deleteremoteagent

Method: POST

Content-Type: application/json

Inputs to be Specified

Parameters	Key values	Example
Headers	managerurl: Base URL of the eG Manager i.e., http://<IP address of the eG console:Port> user: eG username or domain/eG username pwd: Base64 encoded password	{ "agentname":"AG_191" }
Body	Default: { "agentname":"Agent name" }

 

Success Response

Type	Code	Content
JSON	200	{ "Succeed": "Remote agent has been deleted successfully." }

 

Failure Response

Type	Code	Content
JSON	401 UNAUTHORIZED	{ "Error": "The remote agent you are trying to delete does not exist." }

Figure 1 : Deleting a remote agent using Postman REST Client

Deleting a Remote Agent using cURL

To delete a remote agent through the REST API using cURL, the command should be specified in the following format:

curl --location --request POST "http://<eG Manager IP:Port>/api/eg/orchestration/deleteremoteagent" -H "managerurl:http://<eG Manager IP:Port>" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "Content-Type: application/json" --data-raw "{'agentname':'Agent name'}"

Figure 2 shows an example of deleting a remote agent using cURL.

Figure 2 : Deleting a remote agent using cURL