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:
| Code Block |
|---|
{
"change_id": "ticket #1234",
"current": "current",
"description": "Emergency outage",
"element": [
{
"element_name": "Vlan2",
"node_name": "Switch-1"
},
{
"element_name": "regex:^Vlan.*?$",
"node_name": "Switch-2"
}
],
"end": 1684156863,
"frequency": "once",
"id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
"nodes": {},
"options": {},
"start": 1683811263
} |
| Anchor | ||
|---|---|---|
|
...
|
The following tables represents theproperties of an Enterprise Service.
...
Property | Description | Example |
| A globally unique Enterprise Service ID | "63576103ad794974594a1f11" |
name | The name of the Enterprise Service. This is used for identifying the Enterprise Service | "John Test" |
description | A long description of the Enterprise Service | "This is a test Enterprise Service" |
node_name | The name of the node that is created and/or used to store the status and events for the Enterprise Service. | "john_test_ES" |
frequency | How frequently the status of the Enterprise Service is recalculated. | 60 |
last_updated | The time that these status metrics were last recalculated. The metrics are updated with a frequency of frequency seconds. | 1682489067 |
overall_status | The Overall Status can be Up, Degraded or Down. The Overall Status of the Enterprise Service is calculated from the worst of the Node State, Interface State and Service State. | "Down" |
interface_state | If any Interface is marked Down, the Interface State is marked Down, otherwise it is Normal. | "Normal" |
interface_status | A decimal number between 0 (bad) and 100 (good) inclusive representing the status of the interfaces in the Enterprise Service. 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%. | 100 |
interface_status_level | A status level categorizing the interface_status, into traffic light colours. | "Normal" |
interfaces_reachable | A count of the number of interfaces that are reachable or null if there are none. | null |
interfaces_unreachable | A count of the number of interfaces that are unreachable or null if there are none. | 0 |
node_state | If any Node is unreachable, the Node State is marked Down. If any Node is reachable, but it is not at its optimal level/health, the Node State is marked Degraded, otherwise it is Normal. | "Down" |
node_status | A decimal number between 0 (bad) and 100 (good) inclusive representing the status of the nodes in the Enterprise Service. The Node Status is calculated from the status events for the Nodes. It aggregates the status event levels and presents an average of 0% to 100% | 98.3333333333333 |
node_status_level | A status level categorizing the node_status, into traffic light colours. | "Minor" |
nodes_up | A count of the number of nodes that are reachable or null if there are none. | 1 |
nodes_degraded | A count of the number of nodes that are degraded or null if there are none. | 1 |
nodes_down | A count of the number of nodes that are down or null if there are none. | 1 |
nodes_total | A count of the total number of nodes in the Enterprise Service or null if there are none. | 3 |
service_state | If any Monitored Service is marked Down, then the Service State is marked Down, otherwise it is Normal. | "Down" |
service_status | A decimal number between 0 (bad) and 100 (good) inclusive representing the status of the interfaces in the Enterprise Service. The Service Status is calculated from the status events for the Services. It aggregates the status event levels and presents an average of 0% to 100% | 0 |
service_status_level | A status level categorizing the service_status, into traffic light colours. | "Fatal" |
services_degraded | A count of the number of monitored services that are degraded or null if there are none. | 0 |
services_reachable | A count of the number of monitored services that are reachable or null if there are none. | 0 |
services_unreachable | A count of the number of monitored services that are unreachable or null if there are none. | 1 |
...