Outages API - V3
...
Outages API - V3
If you have a maintenance window or a scheduled outage for a device then you will likely want to suspend alerting for that device during that period.
...
All these methods require authentication.
POST http://server/en/omk/admin/login
Form data:
- username
- password
Get Outages
GET http://server/en/omk/admin/api/v3/outages
Returns a list of outages.
...
GET of /v3/outages for List
GET http[s]://server/en/omk/admin/api/v3/outages
If your GET call provides an Accept
header indicating JSON, or if you use a .json
suffix, eg /v3/outages.json
as URI, then It will look for matching Outages and return their properties in the form of a JSON object, an array of Outages.
...
If your GET call provides an accept
header indicating application/json
or if you use /en/omk/admin/api/v3/outages/
<id>.json
as URI, then the Outage will be looked up and all properties will be returned in the form of a JSON object.
...
GET http://server/en/omk/admin/api/v3/outages/#ID
Ex. http://server/en/omk/admin/api/v3/outages/0ea7644e-b6fa-4fa2-9b33-a86b79db21a4
Returns an outage.
Response:
...
The following tables represents theproperties of an Outage.
Property | Description | Example |
| A globally unique Outage ID | "63576103ad794974594a1f11" |
change_id |
current
Insert any reference number if required in the change id field | ticket #12345" | |
current | If the outage is current or scheduled/future outage | "current/null" |
description | Long description of an Outage | "This is a test |
outage" |
description
frequency |
frequency
start
The time that these status metrics were last recalculated. The metrics are updated with a frequency of frequency seconds.
end
nodes
element
The Interface Status is calculated from the status events for the Interfaces by aggregating all the Interface-related status event levels and averaging them out to a value from 0% to 100%.
options
interface_status
, into traffic light colours.one of 'once' , 'daily' , 'weekly' or 'monthly' | ||
start |
| e.g. 2017-10-31T03:04:26+0000 |
end | date and time of outage start and end | e.g. 2017-10-31T03:04:26+0000 |
nodes | List of nodes for which Outages is defined | [ 'Switch-1','Switch-2' ] |
element | List of elements from nodes for which Outages are defined. | [ { "element_name": "Vlan2", "element_name": "regex:^Vlan.*?$", |
options | optional key=values to adjust NMIS' behaviour during an outageo | "Normal" |
Limitations
API Endpoint
All requests are made under the following base URL:
...