Outages API - V2
...
All these methods require authentication.
POST http://server/en/omk/admin/login
Form data:
- username
- password
GET of /v2/outages for List
GET http[s]://server/en/omk/admin/api/v2/outages
If your GET call provides an Accept
header indicating JSON, or if you use a .json
suffix, eg /v2/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.
...
HTTP Status | Body | Description |
---|---|---|
401 Unauthorized | JSON object with an error property | You are not authenticated. |
403 Forbidden | JSON object with an error property | You are not authorized. |
GET http://server/en/omk/admin/api/v2/outages
Returns a list of outages.
...
If your GET call provides an accept
header indicating application/json
or if you use /en/omk/admin/api/v2/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/v2/outages/#ID
Ex. http://server/en/omk/admin/api/v2/outages/1f7ea042-0aaa-46a7-b34b-f9314952ee6f
Returns an outage.
Response:
...
Payload example:
Code Block |
---|
FromBefore opCharts 4.5.7 onwards,only ELEMENTNode OUTAGESoutages are supported { "change_id": "ticket #1234001", "descriptioncurrent": "Emergency outagecurrent", "elementsdescription": : ["testing outage 1", "frequency": "once", { "node_namenodes": ["Switch1","Switch-1111"], "options": { "element_name" : "Vlan2nostats": 0 }, { "node_name"start": "Switch-2"11-May-2023 23:21:03", "end": "15-May-2023 23:21:03" } ################################################################ "element_name" : "regex:^Vlan.*?$" } ]From opCharts 4.5.7 onwards, Element Outages are supported { "change_id": "ticket #1234", "startdescription": "11-May-2023 23:21:03Emergency outage", "endelements": "15-May-2023 23:21:03" } ---------------------------------------------------- { "change_id": "ticket #1234", "description": "Emergency outage", "nodes":["Switch3"], "elements" : [ { "node_name": "Switch-1", "element_name" : "Vlan2" }, { "node_name": "Switch-2", "element_name" : "regex:^Vlan.*?$" } ], "start": "11-May-2023 23:21:03", "end": "15-May-2023 23:21:03" } ############################################### Before opCharts 4.5.7 only Node outages are supported { "change_id": "001 [ { "node_name": "Switch-1", "current" "element_name" : "currentVlan2", "description": "testing outage 1"}, "end": 1684763940, { "frequencynode_name": "onceSwitch-2", "element_name" : "nodes":["Switch1","Switch-111"],regex:^Vlan.*?$" "options": { } ], "nostats": 0 "start": }"11-May-2023 23:21:03", "startend": 1684072800"15-May-2023 23:21:03" } |
Return
Returns 200 if the outage was successfully created.
...
DELETE http://server/en/omk/admin/api/v2/outages/0ea7644e-b6fa-4fa2-9b33-a86b79db21a4
Returns 200 if the outage was successfully removed.
...
Property | Description | Example |
| A globally unique Outage ID | 0ea7644e-b6fa-4fa2-9b33-a86b79db21a4 |
change_id | Insert any reference number if required in the change id field | ticket #12345 |
current | If the outage is current or scheduled/future outage. IS THIS 'current' for scheduled or null for future. | current |
description | Long description of an Outage | This is a test outage |
frequency | one of 'once', 'daily', 'weekly' or 'monthly' | once |
start | date and time of outage start. For Read, this is a Unix timestamp, the number of seconds since 1970-01-01 00:00:00 UTC | 2023-10-31T17:00:00+0000 |
end | date and time of outage end. For Read, this is a Unix timestamp, the number of seconds since 1970-01-01 00:00:00 UTC For Create and Update see Supported Time Formats for description of allowed values | 31 May 2023 03:30 pm |
nodes | List of nodes for which Outages are defined. At least one of nodes or elements must be specified. | [ 'Switch-1','Switch-2' ] |
element | List of elements from nodes for which Outages are defined. element_name must be either a string or a regex pattern ( regex:pattern or iregex:pattern as shown in examples) element_name can be either interface name or other. | [ { "element_name": "Vlan2", "element_name": "iregex:^Vlan.*?$", [ { "node_name": "Switch-1" "element_name": "regex:^Vlan.*?$", |
options | optional key=values to adjust NMIS behaviour during an outage DOCUMENT THE KEYS AND VALUES | "Normal" |
...