Summary:
Lists available incidents.
URL:
http(s)://{server hostname}/api/incidents
Methods summary
- GET Method - lists available incidents.
GET Method detail
Lists available incidents.
Request:
| Name | Description |
|---|---|
|
updateId |
incident update identifier, use the updateId from the last result set to get new incidents. |
|
view |
incidents filtered by view. |
|
mask |
incident severity mask, severities can be added together to request multiple severities together
e.g. mask=24 would return both Server and Critical incidents. |
|
states |
incident state, either “open”, “closed”, “expire” and “all”. Multiple incident states can be specified together e.g. states=open&states=closed |
|
openedFrom |
incident opening time lower bound. |
|
openedTo |
incident opening time upper bound. |
|
closedFrom |
incident closing time lower bound. |
|
closedTo |
incident closing time upper bound. |
Response:
Response includes an array of event. Each event has following attributes:
| Name | Description |
|---|---|
|
description |
event description. |
|
details |
event details. |
|
objectKeyInfo |
object key, consisting of :
|
|
severity |
incident severity
|
|
sourceDescription |
source description. |
|
impactDescription |
impact description. |
|
timeStamp |
event timestamp. |
|
id |
incident Identifier. |
|
state |
incident state. |
|
annotation |
incident annotation. |
|
eventCount |
number of events contributing to the incident. |
|
extraAttribs |
attribute key value pairs for the incident. |
Examples:
INPUT
curl -u admin:admin https://localhost/api/incidents?media=json
OUTPUT
{
"incidents" : [ {
"description" : "Entuity Server Component Problem",
"details" : "Reason for event",
"objectKeyInfo" : {
"swId" : 815,
"compId" : {
"ids" : [ 1, 2, 3, 0 ]
}
},
"severity" : 6,
"sourceDescription" : "London01",
"impactDescription" : "",
"timeStamp" : 1540900781,
"id" : 69,
"state" : "open",
"annotation" : "test annotation",
"eventCount" : 1,
"extraAttribs" : {
"attribKey" : “Attrib value"
}
}, {
...removed for brevity...
} ],
"updateId" : 799,
"count" : 2
}
INPUT
curl -u admin:admin https://localhost/api/incidents?media=xml
OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<incidentsCollection count="2" updateId="799">
<incidents>
<incident id="69" eventCount="1" state="open" annotation="" severity="6" timeStamp="1540900781" id="69"> <description>Entuity Server Component Problem</description>
<details>Reason for event</details>
<objectKeyInfo>
<swId>815</swId>
<compId>
<ids>
<ids>1</ids>
<ids>2</ids>
<ids>3</ids>
<ids>0</ids>
</ids>
</compId>
</objectKeyInfo>
<sourceDescription>Huge</sourceDescription>
<impactDescription></impactDescription>
<extraAttribs>
<entry>
<key>attribKey</key>
<value>Attrib value</value>
</entry>
</extraAttribs>
</incident>
<incident
...removed for brevity...
</incident>
</incidents>
</incidentsCollection>
Comments
0 comments
Please sign in to leave a comment.