Retrieving Zone Details from eG Manager

To retrieve the details of the zones and the elements associated with the zone (services, segments, servers etc), administrators can use the eG REST API. The URL can be specified in the following format:

URL: http://<eG manager IP:port>/api/eg/miscservice/getZoneMapping

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	[ { "zone": "james_zone", "groups": [], "services": [ "service1", "james_for_sm" ], "segments": [ "segment_james" ], "components": [ "OFFICE-365_ymr:Microsoft Yammer" ], "subZones": [] } ]

 

Failure Response

Type	Code	Content
JSON	401 UNAUTHORIZED	{"code": 401,"error": "Invalid username or password."}
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 created in the target environment using Postman REST Client

Retrieving Zone Details from eG Manager using cURL

To retrieve the details of the zones and the elements associated with the zone (services, segments, servers etc) in the target environment using cURL, the command should be specified in the following format:

curl -L -X POST "http://<eG Manager IP:Port>/api/eg/miscservice/getZoneMapping" -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 created in the target environment using cURL.

Figure 2 : Retrieving the details of the zones created in the target environment using cURL