Strategic Group Status API

Netreo's API system must be enabled to use this API. See How to Enable Netreo API Access

Calls to this API are made using HTTP/HTTPS and are sent as key/value pairs in a GET or POST request.

Resource

The resource accessed by this API is the list of Netreo's active strategic groups ("application" is a legacy name for strategic group).

This resource offers the following endpoints:

• Strategic Group Health Score

Resource URL

{your.netreo.ip.or.name}/api

Endpoints

Strategic Group Health Score

GET or POST
/application_overview_info_api.php
Returns a list of strategic groups and their current health score.

Parameters

The parameters for this endpoint can be included as query string parameters in a GET request, or as request body parameters in a POST request.

pwd
String/Required if authentication is enabled.
The API key set in Netreo’s API Administration. Case-sensitive.

pin
String/Required when using Netreo SaaS-based APIs. Not applicable to on-premise deployments.
The pin number supplied in Netreo’s API Administration.

user_name
String/Required
A valid Netreo web-user name (case sensitive). Users with device restrictions will only see strategic groups that contain devices to which they have access.

password
String/Required
The password for the username provided (case sensitive).

application_name
String/Optional
The name of a specific strategic group. If this is specified, the API will only return the health score for that particular strategic group. If not used, the API will return health scores for all enabled strategic groups.

Request Examples

Retrieve Strategic Group List with Scores Using GET

http://38.2.11.62/api/application_overview_info_api.php?user_name=administrator&password=password1

Retrieve Single Strategic Group with Score Using GET

http://38.2.11.62/api/application_overview_info_api.php?user_name=administrator&password=password&application_name=windows%20servers

Response

A successful call to this API will return an XML array.

For each strategic group returned, the name of the strategic group and the strategic group's current health score will be returned as a percentage.

Response Examples

Retrieve all strategic groups

<System>
 <Application>
  <Name>Everything</Name>
  <App_Score>93.98</App_Score>
 </Application>
 <Application>
  <Name>Infrastructure</Name>
  <App_Score>99.87</App_Score>
 </Application>
 <Application>
  <Name>Mail</Name>
  <App_Score>100.00</App_Score>
 </Application>
 <Application>
  <Name>Unix/Linux Servers</Name>
  <App_Score>100.00</App_Score>
 </Application>
 <Application>
  <Name>Web</Name>
  <App_Score>100.00</App_Score>
 </Application>
 <Application>
  <Name>Windows Servers</Name>
  <App_Score>84.88</App_Score>
 </Application>
</System>

Retrieve specific strategic group

<System>
 <Application>
  <Name>Windows Servers</Name>
  <App_Score>84.88</App_Score>
 </Application>
</System>

With Incorrect Password

<System>
 <Result>
  Authentication of local user administrator failed. Passwords did not match.
 </Result>
</System>

Response Schema