Displaying External Agents

Use this API to display all the external agents in the target environment.

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

Method: POST

Content-Type: application/json

Inputs to be Specified
Parameters Key values Example

Header

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

Not Applicable

 

Success Response
Type Code Content

JSON

200

[

{

"agentName": "mobilecollector",

"hostIp": "mobilecollector"

},

.

.

.

]

Displaying External Agents Using Postman REST Client

Figure 1 : Displaying the External agents in the target environment using Postman REST Client

Displaying External Agents using cURL

To display all the external agents in the target environment 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/showexternalagents" -H "managerurl:http://<eG Manager IP:Port>" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password"

Figure 2 shows an example of displaying all the external agents in the target environment using cURL.

Displaying External Agents Using cURL

Figure 2 : Displaying all the external agents in the target environment using cURL