Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In Development
Status
colourYellow
title
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 OutagesGEThttp://server/en/omk/admin/api/v2/outages
Get an OutageGEThttp://server/en/omk/admin/api/v2/outages/:id
Create an OutagePOSThttp://server/en/omk/admin/api/v2/outages
Update an OutagePUThttp://server/en/omk/admin/api/v2/outages
Delete an OutageDELETEhttp://server/en/omk/admin/api/v2/outages/:id


Note: At the moment, this only works for local nodes. 

...

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/v2/outages

Returns a list of outages.

...

GET http://server/en/omk/admin/api/v2/outages/#ID

Ex. http://server/en/omk/admin/api/v2/outages/f14d4f34-2fd0-4be0-9d54-7431c5de294f

Returns an outage.

Response:

...

DELETE http://server/en/omk/admin/api/v2/outages/2a07c78a-65b6-49df-a052-a97d7a899c58

Returns 200 if the outage was successfully removed.