Versions Compared

Key

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

Status
colourYellow
titleIn Development

...

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:

...

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

...

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 if the outage was successfully removed.