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
Methods
Get Outages
GET http://server/en/omk/admin/api/v3/outages
Returns a list of outages.
...
GET http://server/en/omk/admin/api/v3/outages/#ID
Ex. http://server/en/omk/admin/api/v3/outages/e6d371a0-2b74-4dd3-9bc9-fca14f8ddc4f
Returns an outage.
Response:
...
Code Block |
---|
{ "change_id": "ticket #1234", "description": "Emergency outage", "element": [ { "element_name": "Vlan2", "node_name": "Switch-1" }, { "element_name": "regex:^Vlan.*?$", "node_name": "Switch-32" } ], "end": 1647004863, "frequency": "once", "id": "e6d371a08b46a6f6-2b741b0d-4dd34e46-9bc9a081-fca14f8ddc4fd58731abbdf7", "nodes": { "name": [ "Switch-2", "Switch-3", "Switch-1" ] }, "options": {}, "start": 1646918463 } |
...
Code Block |
---|
{ "change_id": "ticket #1234", "description": "Emergency outage", "nodes": ["Switch-2","Switch-3","Switch-1"], "elements" : [ { "node_name": "Switch-1", "element_name" : "Vlan2" }, { "node_name": "Switch-32", "element_name" : "regex:^Vlan.*?$" } ], "start": "10-Mar-2022 23:21:03", "end": "11-Mar-2022 23:21:03" } |
...
Returns:
Code Block |
---|
{ "id": "e6d371a08b46a6f6-2b741b0d-4dd34e46-9bc9a081-fca14f8ddc4fd58731abbdf7", "success": 1 } |
Update Outage
PUT PUT http://server/en/omk/admin/api/v3/outages/#ID
Returns 200 if the outage was successfully updated.
...
Code Block |
---|
{ "change_id": "ticket #1234", "description": "Emergency outage", "nodes": ["Switch-2","Switch-3","Switch-1"], "elements" : [ { "node_name": "Switch-1", "element_name" : "Vlan2Vlan22" }, { "node_name": "Switch-32", "element_name" : "regex:^Vlan.*?$" } ], "start": "10-Mar-2022 23:21:03", "end": "11-Mar-2022 23:21:03" } |
Return
Code Block |
---|
test-response{ "id": "8b46a6f6-1b0d-4e46-a081-d58731abbdf7", "success": 1 } |
Delete Outage
Returns 200 if the outage was successfully removed.
...