Retrieving Details of Zones Associated with a User

To retrieve the details of the zones such as the count of zones, name of the zones and their severity for each user logged into eG Enterprise, administrators can use the eG REST API. The URL can be specified in the following format:

URL: http://<eG manager IP:port>/api/eg/analytics/getZones

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

Not Applicable

 

Success Response
Type Code Content

JSON

200

{

"Total": 4,

"Summary": [

{

"critical": 3,

"color": "#cd0f0f"

},

{

"major": 0,

"color": "#fa9d1c"

},

{

"minor": 1,

"color": "#ccc100"

},

{

"unknown": 0,

"color": "#30a1d9"

},

{

"normal": 0,

"color": "#0c9a12"

}

],

"Details": [

{

"name": "citrixcloud",

"priority": "critical"

},

{

"name": "citrixonprem",

"priority": "critical"

},

{

"name": "egAgentZone",

"priority": "critical"

},

{

"name": "george@egindia.com",

"priority": "minor"

}

]

}

 

 

Failure Response
Type Code Content

JSON

401 UNAUTHORIZED

{"code": 401,"error": "Unauthorized user"}

JSON

400 BAD REQUEST

{"code": 400,"error": "Bad Request. Header parameters : Username or Password or Manager URL is missing"}

or

{"code": 400,"error": "Bad Request. Header parameters : Manager URL, Username or Password is not provided"}

JSON

500 Server Error

{"code": 500,"error": " Server Error. Please check /manager/logs/error_log in the installation directory for more information."}

Figure 1 : Retrieving the details of the zones associated with a user using Postman REST Client

Retrieving Details of Zones Associated with Users using cURL

To retrieve the details of the zones associated with a user logged into eG Enterprise using cURL, the command should be specified in the following format:

curl -location -request POST "http://<eG Manager IP:Port>/api/eg/analytics/getZones" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "managerurl:http://<eG Manager IP:Port>"

Figure 2 shows an example for retrieving the details of all the zones associated with a user using cURL.

Figure 2 : Retrieving the details of all the zones associated with a user using cURL