Incidents 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 currently "active" incidents in Netreo.

This resource offers the following endpoints:

• Active Incident List

Resource URL

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

Endpoints

Active Incident List

GET or POST
/incident_api.php
Retrieves the list of active incidents and their related data.

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.

method
String/Required

• getincidents retrieves a list of all currently active incidents (i.e. incidents that are not closed).
• getincidentdetail retrieves complete detailed information about a specific incident along with detailed information on the device that the primary alarm in the incident is related to, if any.

incident_id
String/Required if using getincidentdetail
The unique ID of the incident for which you wish to retrieve details. Only used when using getincidentdetail for the method request above.

Request Examples

Retrieving all active incidents using GET with API authentication enabled

http://38.2.11.62/api/incident_api.php?method=getincidents&pwd=PassWord1234

Retrieving detailed information on a specific incident using GET with API authentication enabled

http://38.2.11.62/api/incident_api.php?method=getincidentdetail&incident_id=CustomerCorp-1325&pwd=PassWord1234

Response

A successful or unsuccessful call to this API will return a standard JSON object.

Response Examples

Note: The output will be returned as standard JSON without indentation or line breaks. It is formatted here to make the examples easier to read.

Active Incident List

{
    "result":"completed",
    "active_incidents":
     [
        {
            "title":"Application Service for Support",
            "incident_state":"OPEN",
            "incident_id":"sw_omni_9_1-1156",
            "open_time":"2016-07-20T14:55:32"
        },
        {
            "title":"Service EIGRP on Router1",
            "incident_state":"OPEN",
            "incident_id":"CustomerCorp-1325",
            "open_time":"2016-07-22T09:26:33",
            "name":"Router1",
            "device_category":"Core Routers",
            "device_site":"netreo_hq",
            "device_note":"This is an arbitrary note for router1."
        },
        {
            "title":"Service for Device Polling Status on Lync2013_netreo-test_info",
            "incident_state":"OPEN",
            "incident_id":"CustomerCorp-2232",
            "open_time":"2016-08-01T12:16:23",
            "name":"Lync2013_netreo-test_info",
            "device_category":"Windows Servers",
            "device_site":"netreo_hq",
            "device_note":""
        }
     ]
}

Single Incident

 {
      "result":"completed",
      "incident":
       {
           "title":"Service EIGRP on Router1",
           "incident_state":"OPEN",
           "incident_id":"sw_omni_9_1-1325",
           "name":"Router1",
           "device_category":"Core Routers",
           "device_site":"netreo1",
           "related_strategic_groups":
               [
                   "Infrastructure"
               ],
           "device_note":"This is an arbitrary note for router1.",
           "device_documentation":
               [
                 "documentation":
                [
                     {
                        "name":"Router",
                        "value":"1"
                     },
                     {
                        "name":"Where",
                        "value":"Backroom"
                     },
                  ],
               "reference_contact":
                  [
                       {
                          "Contact Address":"8717 Research Dr",
                          "Contact City":"Irvine",
                          "Contact Country":"US",
                          "Contact Email":"info@netreo.com",
                          "Contact Name":"Info",
                          "Contact Number":"949-769-5700",
                          "Contact State":"CA",
                          "Contact Zip":"92708"
                      },
                      {
                          "Contact Address":"8717 Research Dr",
                          "Contact City":"Irvine",
                          "Contact Country":"United States",
                          "Contact Email":"engineering@netreo.com",
                          "Contact Name":"Engineering",
                          "Contact Number":"9497695700",
                          "Contact State":"CA",
                          "Contact Zip":"92708"
                     }
                  ],
             ],
         "primary_alarm_state":"OPEN",
         "incident_open_time":"2016-07-22T09:26:33",
         "acknowledged":0,
         "ack_time":"",
         "ack_user":"",
         "ack_comment":"",
         "alert_type":"Service",
         "detail":
             {
                 "primary_alarm_log":
                     [
                         {
                             "state":"UNKNOWN",
                             "type":"Service",
                             "name":"Router1",
                             "output":"EIGRP Neighbors not available",
                             "time":"2016-07-22T09:26:23"
                         }
                     ],
                 "relatedalarms":
                     [],
                 "incident_log":
                     [
                         {
                             "state":"OPEN",
                             "time":"2016-07-22T09:26:33",
                             "username":"system",
                             "comment":"Initialized state to OPEN"
                          }
                     ]
             }
     }
 }

Response Schema

Active Incident List

Single Incident