...

Now, it is also possible to manage Outages within the Administration console or API.

The v3 api has added support for "ELEMENT OUTAGES" and this is not backward compatible with v2 api. If you make a v2 api call, it will not return any outages that are "ELEMENT OUTAGES".

See ALL ABOUT ELEMENT OUTAGES

Public API for Outages "http[s]://server/en/omk/admin/api/v3/outages"

We can view Enterprise Services Outages below using these endpoints - http[s]://server/en/omk/admin/api/v3/outages

...

...

Form data:

• username
• password

Get Outages

GET of /v3/outages for List

GET http[s]GET http://server/en/omk/admin/api/v3/outages

Returns a list of outages.

Response:

If your GET call provides an Accept header indicating JSON, or if you use a .json suffix, eg /v3/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.

Successful Response

Unsuccessful Response

GET http://server/en/omk/admin/api/v3/outages

Returns a list of outages.

Response:

[
    {

[
    {
        "change_id": "ticket #1234",
        "current": "current",
        "descriptionchange_id": "Emergencyticket outage#1234",
        "elementcurrent": ["current",
        "description":    {"Emergency outage",
        "element": [
            {
                "element_name": "Vlan2",
                "node_name": "Switch-1"
            },
            {
                "element_name": "regex:^Vlan.*?$",
                "node_name": "Switch-2"
            }
        ],
        "end": 1684156863,
        "frequency": "once",
        "id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
        "nodes": {
            "name": [
                "Switch-2",
                "Switch-1"
            ]
        },
        "options": {},
        "start": 1683811263
    },
    {
        "change_id": "Outage_123_AT_OPTESTS",
        "current": null,
        "description": "Emergency outage",
        "end": 1683825925,
        "frequency": "once",
        "id": "ea7a3a94-f056-432f-91c5-9f39eee7c706",
        "nodes": {
            "name": [
                "asgard",
                "apc-ups"
            ]
        },
        "options": {},
        "start": 1646918463
    }
]

GET of /v3/outages/<id> for

...

Read

GET http[s]://serverIf your GET call provides an accept header indicating application/json or if you use /en/omk/admin/api/v3/outagesIf your GET call provides an Accept header indicating JSON, or if you use a .json suffix, eg /v3/outages/<id>.json as URI, then It will look for matching Outages and return their properties the Outage will be looked up and all properties will be returned in the form of a JSON object, an array of Outages.

Successful Response

Unsuccessful Response

GET of /v3/outages/<id> for Read

GET http://server/en/If your GET call provides an accept header indicating application/json or if you use /en/omk/admin/api/v3/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.

Successful Response

...

HTTP Status

...

Body

...

Unsuccessful Response

...

HTTP Status

...

Body

...

Description

...

The error property contains an explanation of what went wrong
with your request, e.g. if you request a non-existent Outage.

#ID

Ex. http://server/en/omk/admin/api/v3/outages/0ea7644e-b6fa-4fa2-9b33-a86b79db21a4

Returns an outage.

Response:

{
    "change_id": "ticket #1234",
    "current": "current",
    "description": "Emergency outage",
    "element": [
        {
            "element_name": "Vlan2",
            "node_name": "Switch-1"
        },
        {
            "element_name": "regex:^Vlan.*?$",
            "node_name": "Switch-2"

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

Ex. http://server/en/omk/admin/api/v3/outages/0ea7644e-b6fa-4fa2-9b33-a86b79db21a4

Returns an outage.

Response:

{
    "change_id": "ticket #1234",
    "current": "current",
    "description": "Emergency outage",
    "element": [
        {}
    ],
    "end": 1684156863,
    "element_namefrequency": "Vlan2once",
            "node_nameid": "Switch-1"0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
        "nodes": {},
        {"options": {},
            "element_name": "regex:^Vlan.*?$",
            "node_name": "Switch-2"
        }
    ],
    "end": 1684156863,
    "frequency": "once",
    "id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
    "nodes": {},
    "options": {},
    "start": 1683811263
}

Create Outage
POST  http://server/en/omk/admin/api/v3/outages

Returns 201 if the outage was successfully created.

Payload example:

"start": 1683811263
}

POST of /v3/outages/ for Create

Create an Outage by sending a pay-load JSON object and this will create an Outage on your system and send an appropriate response.

Successful Response

Unsuccessful Response

Create Outage
POST  http://server/en/omk/admin/api/v3/outages

Returns 201 if the outage was successfully created.

Payload example:

{
    "change_id": "ticket #1234",
    "description": "Emergency outage",
    "nodes": ["Switch-2","Switch-1"],
    "elements" : [

{
    "change_id": "ticket #1234",
    "description": "Emergency outage",
    "nodes": ["Switch-2","Switch-1"],
    "elements" : [
        {  "node_name": "Switch-1",
           "element_name" : "Vlan2"
        },
        {  "node_name": "Switch-21",
           "element_name" : "regex:^Vlan.*?$Vlan2"
        },
      ],
  {  "startnode_name": "11-May-2023 23:21:03"Switch-2",
           "element_name" : "regex:^Vlan.*?$"
        }
    ],
    "endstart": "1511-May-2023 23:21:03"
}

Return

,
    "end": "15-May-2023 23:21:03"
}

Return

{
    "id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
    "success": 1
}

...

PUT

...

of /v3/outages/

...

<id> for Update

Create an Outage by sending a pay-load JSON object and this will create an Outage on your system and receive an appropriate response.

Successful Response

Unsuccessful Response

Update Outage

PUT http://server/en/omk/admin/api/v3/outages/#ID

Returns 200 if the outage was successfully updated.

Payload example:

{
    "change_id": "ticket #1234",
    "description": "Emergency outage",
    "nodes": ["Switch-2","Switch-1"],
    "elements" : [
     

Returns 200 if the outage was successfully updated.

Payload example:

{
    "change_id": "ticket #1234",
    "description": "Emergency outage",
    "nodes": ["Switch-2","Switch-1"],
    "elements" : [
        {  "node_name": "Switch-1",
           "element_name" : "Vlan222"
        },
        {  "node_name": "Switch-21",
           "element_name" : "regex:^Vlan.*?$"
        }
    ],
    "start": "11-May-2023 23:21:03",
    "end": "15-May-2023 23:21:03"
}

Return 

...

" : "Vlan222"
        },
        {  "node_name": "Switch-2",
           "element_name" : "regex:^Vlan.*?$"
        }
    ],
    "start": "11-May-2023 23:21:03",
    "end": "15-May-2023 23:21:03"
}

Return 

{
    "id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
    "success": 1
}

Delete of /v3/outages/<id> for Create

Create an Outage by sending a pay-load JSON object and This will create an Outage on your system and receive an appropriate response.

Successful Response

Unsuccessful Response

...

Delete Outage

DELETE http://server/en/omk/admin/api/v3/outages/0ea7644e-b6fa-4fa2-9b33-a86b79db21a4

Returns 200 if the outage was successfully removed.

Anchor
properties properties

Outages Properties

...

Limitations

API Endpoint

...