...
Form data:
- username
- password
Get Outages
GET of /v3/outages for List
GET http[s]://server/en/omk/admin/api/v3/outages
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
HTTP Status | Body | Description |
|---|---|---|
| 200 | Possibly empty JSON array of objects | Each array element is a JSON object with the raw properties of the Outages in question, described in known Outage properties. |
Unsuccessful Response
HTTP Status | Body | Description |
|---|---|---|
| 401 Unauthorized | JSON object with an error property | You are not authenticated. |
| 403 Forbidden | JSON object with an error property | You are not authorized. |
GET http://server/en/omk/admin/api/v3/outages
...
| Code Block |
|---|
[
{
"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"
}
],
"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
...
/
...
Successful Response
...
HTTP Status
...
Body
...
Description
...
Unsuccessful Response
...
HTTP Status
...
Body
...
Description
...
GET of /v3/outages/<id> for Read
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.
...
| Code Block |
|---|
{
"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"
}
],
"end": 1684156863,
"frequency": "once",
"id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
"nodes": {},
"options": {},
"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 receive an appropriate response.
Successful Response
HTTP Status | Body | Description |
|---|---|---|
| 201 | JSON object with success and id properties | The success property is set to 1 and only if the request was successful. The id property is the new event's ID |
Unsuccessful Response
HTTP Status | Body | Description |
|---|---|---|
| 400 Bad Request | JSON object with an error property | The error property contains an explanation of what went wrongwith your request, e.g. if your payload is of wrong format to create an Outage. |
| 401 Unauthorized | JSON object with an error property | You are not authenticated. |
| 404 Not Found | JSON object with an error property | You are authenticated but not authorised to create an Outage. |
Create Outage
POST http://server/en/omk/admin/api/v3/outages
Returns 201 if the outage was successfully created.
Payload example:
| Code Block |
|---|
{
"change_id": "ticket #1234",
"description": "Emergency outage",
"nodes": ["Switch-2","Switch-1"],
"elements" : [
{ "node_name": "Switch-1",
"element_name" : "Vlan2"
},
{ "node_name": "Switch-2",
"element_name" : "regex:^Vlan.*?$"
}
],
"start": "11-May-2023 23:21:03",
"end": "15-May-2023 23:21:03"
} |
Return
| Code Block |
|---|
{
"id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
"success": 1
} |
PUT 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
HTTP Status | Body | Description |
|---|---|---|
| 201 | JSON object with success and id properties | The success property is set to 1 and only if the request was successful. The id property is the new event's ID |
Unsuccessful Response
HTTP Status | Body | Description |
|---|---|---|
| 400 Bad Request | JSON object with an error property | The error property contains an explanation of what went wrongwith your request, e.g. if your payload is of wrong format to edit an Outage. |
| 401 Unauthorized | JSON object with an error property | You are not authenticated. |
| 404 Not Found | JSON object with an error property | You are authenticated but not authorised to create an Outage. |
Update Outage
PUT http://server/en/omk/admin/api/v3/outages/#ID
Returns 200 if the outage was successfully updated.
Payload example:
| Code Block |
|---|
{
"change_id": "ticket #1234",
"description": "Emergency outage",
"nodes": ["Switch-2","Switch-1"],
"elements" : [
{ "node_name": "Switch-1",
"element_name" : "Vlan222"
},
{ "node_name": "Switch-2",
"element_name" : "regex:^Vlan.*?$"
}
],
"start": "11-May-2023 23:21:03",
"end": "15-May-2023 23:21:03"
} |
...
| Code Block |
|---|
{
"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
HTTP Status | Body | Description |
|---|---|---|
| 200 | JSON object with success | The success property is set to 1 and only if the request was successful. |
Unsuccessful Response
HTTP Status | Body | Description |
|---|---|---|
| 400 Bad Request | JSON object with an error property | The error property contains an explanation of what went wrongwith your request, e.g. if your id does not exist of wrong id format. |
| 401 Unauthorized | JSON object with an error property | You are not authenticated. |
| 404 Not Found | JSON object with an error property | You are authenticated but not authorised to delete an Outage. |
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 | ||||
|---|---|---|---|---|
|
...