Versions Compared

Key

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

...

Code Block
[
    {
        "change_id": "123456",
        "current": "current",
        "description": "testing 123456",
        "end": 1683381540,
        "frequency": "once",
        "id": "df0affe5-a16f-4fa2-a299-5376a3fabb73",
        "nodes": {
            "group": [
                "HQDev"
            ],
            "name": [
                "Switch-1"
            ],
            "nodeStatus": [
                "reachable"
            ],
            "nodeType": [
                "switch",
                "server",
                "generic"
            ],
            "nodeVendor": [
                "Cisco Systems"
            ],
            "roleType": [
                "test2"
            ]
        },
        "options": {
            "nostats": 0
        },
        "start": 1683122400
    },
    {
        "change_id": "1",
        "current": "current",
        "description": "test-outage",
        "end": 1683381540,
        "frequency": "once",
        "id": "10d3558d-1819-4492-8ff5-a5629663e0d7",
        "nodes": {
            "name": [
                "fulla"
            ]
        },
        "options": {
            "nostats": 0
        },
        "start": 1683122400
    }
]



Get Outage

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

Ex. http://server/en/omk/admin/api/v3/outages/

...

df0affe5-

...

a16f-

...

4fa2-

...

a299-

...

5376a3fabb73

Returns an outage.

Response:


Code Block
{
    "change_id": "123456",
    "current": "current",
    "description": "testing 123456",
    "end": 1683381540,
    "frequency": "once",
    "id": "df0affe5-a16f-4fa2-a299-5376a3fabb73",
    "nodes": {
        "group": [
            "HQDev"
        ],
        "name": [
            "Switch-1"
        ],
        "nodeStatus": [
            "reachable"
        ],
        "nodeType": [
            "switch",
            "server",
            "generic"
        ],
        "nodeVendor": [
            "Cisco Systems"
        ],
        "roleType": [
            "test2"
        ]
    },
    "options": {
        "nostats": 0
    },
    "start": 1683122400
}



Create Outage

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

Returns 200 if the outage was successfully created.

Payload example:


Code Block
test-block


Returns:

Code Block
test-response

Update Outage

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

Returns 200 if the outage was successfully updated.

Payload example:



Code Block
test-block-payload


Return 

Code Block
test-response



Delete Outage

DELETE http://server/en/omk/admin/api/v3/outages/df0affe5-a16f-4fa2-a299-5376a3fabb73

Returns 200 if the outage was successfully removed.