Deleting an External Agent
Using this API, administrators can delete an external agent from the eG manager.
URL: http://<eG manager IP:port>/api/eg/orchestration/deleteexternalagent
Method: POST
Content-Type: application/json
| 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":"ext191" } |
|
Body |
Default: { "agentname":"Agent name" } |
| Type | Code | Content |
|---|---|---|
|
JSON |
200 |
{ "Succeed": "External agent has been deleted successfully." } |
| Type | Code | Content |
|---|---|---|
|
JSON |
401 UNAUTHORIZED |
{ "Error": "The external agent you are trying to delete does not exist." } |
Figure 1 : Deleting an external agent using Postman REST Client
Deleting an External Agent using cURL
To delete an external 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/deleteexternalagent" -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'}"
shows an example of deleting an external agent using cURL.
Figure 2 : Deleting an external agent using cURL
