Status colour Yellow title In Development
Table of Contents
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.
...
Now, it is also possible to manage Outages within the Administration console or API.
Released in opCharts 4.3.5
Summary
Operation | Method | API |
|---|---|---|
| Get a list of Outages | GET | http://server/en/omk/admin/api/v2/outages |
| Get an Outage | GET | http://server/en/omk/admin/api/v2/outages/:id |
| Create an Outage | POST | http://server/en/omk/admin/api/v2/outages |
| Update an Outage | PUT | http://server/en/omk/admin/api/v2/outages |
| Delete an Outage | DELETE | http://server/en/omk/admin/api/v2/outages/:id |
Note: At the moment, this only works for local nodes.
Authentication
All these methods require authentication.
...
| Code Block |
|---|
[
{
"change_id": "ticket #1234",
"current": "current"null,
"description": null"my_test_outage",
"end": 16468314101678627263,
"frequency": "once",
"id": "4dab2e5da059db21-de6bd7c8-4d2f4fc8-946a9e95-cc83edba9febad47b5ba3dae",
"optionsnodes": {},[
"selector": {
"nodeasgard": {,
"name": "amor"apc-ups"
],
}
"options": {},
"start": 16468281101678454463
},
{
"change_id": "ticket #1234",
"current": null,
"description": null"my_test_outage",
"end": 16476954951678627263,
"frequency": "once",
"id": "f14d4f34a9dac944-2fd0ef21-4be04019-9d54a24d-7431c5de294fd993926922a1",
"optionsnodes": {},[
"selector": {
"node": {
"asgard",
"name": "asgard"apc-ups"
],
}
"options": {},
"start": 16476921951678454463
}
] |
Get Outage
GET http://server/en/omk/admin/api/v2/outages/#ID
...
Response:
| Code Block |
|---|
{
"change_id": "ticket #""1234",
"current": null,
"description": null"my_test_outage",
"end": 16476954951678627263,
"frequency": "once",
"id": "f14d4f34e5ad10c2-2fd05869-4be04b03-9d54ae6a-7431c5de294fc4d86a174688",
"optionsnodes": {},
"selector": {
[
"nodeasgard": {
,
"name": "asgardapc-ups"
],
}
"options": {},
"start": 16476921951678454463
} |
Create Outage
POST http://server/en/omk/admin/api/v2/outages
Returns 201 200 if the outage was successfully created.
...
| Code Block |
|---|
{
"change_id": "ticket #1234",
"description": "Emergency outage",
"end": "11-Mar-2022 23:21:03",
"nodes": ["Asgard","apc-ups"],
"start": "10-Mar-2022 23:21:03"
} |
Returns:
| Code Block |
|---|
{
"id": "9ede91fc-45c3-4538-8bbd-35ddc893a51f",
"success": 1
} |
Update Outage
PUT http://server/en/omk/admin/api/v2/outages
Returns 201 200 if the outage was successfully updated.
...
| Code Block |
|---|
{
"change_id": "ticket #1234",
"description": "Firewall updates",
"end": "11-Mar-2022 23:21:03",
"nodes": ["Asgard","apc-ups"],
"start": "10-Mar-2022 23:21:03",
"id": "9ede91fc-45c3-4538-8bbd-35ddc893a51f"
} |
Returns:
| Code Block |
|---|
{ "id": "9ede91fc-45c3-4538-8bbd-35ddc893a51f", "success": 1 } |
Delete Outage
DELETE http://server/en/omk/admin/api/v2/outages/2a07c78a-65b6-49df-a052-a97d7a899c58
Returns 201 200 if the outage was successfully removed.