Versions Compared

Old Version 21

changes.mady.by.user Krishna Devaraya

Saved on

compared with

New Version 22

changes.mady.by.user John Sinclair

Saved on

Key

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

...

Update an Outage by sending a pay-load JSON object, which will update the Outage on your system and receive an appropriate response.

Successful Response

HTTP Status

Body

Description
200JSON object with success and id propertiesThe 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 RequestJSON object with an error propertyThe error property contains an explanation of what went wrong
with your request, e.g. if your payload is of wrong format to edit an  Outage.
401 UnauthorizedJSON object with an error propertyYou are not authenticated.
404 Not FoundJSON object with an error propertyYou are authenticated but not authorised to create an Outage.



...

The following table lists theproperties of an Outage.

Property

Description

Example

id

A globally unique Outage ID

0ea7644e-b6fa-4fa2-9b33-a86b79db21a4
change_id

Insert any reference number if required in the change ID field

ticket #12345
currentIf the outage is current or scheduled/future outage. IS THIS 'current' for scheduled or null for future.current
descriptionLong description of an Outage.This is a test outage
frequencyFrequency may be once, daily, weekly or monthly.once
start

Date and time when the outage shall start.

For Read, this is a Unix timestamp, the number of seconds since 1970-01-01 00:00:00 UTC.
For Create and Update, see Supported Time Formats for a description of the values allowed.

 2023-10-31T17:00:00+0000
endDate and time when the outage shall end.
For Read, this is a Unix timestamp, the number of seconds since 1970-01-01 00:00:00 UTC.
For Create and Update, see Supported Time Formats for a description of the values allowed. 		 31 May 2023 03:30 pm
nodesList of nodes for which Outages are defined. At least one nodes or an elements must be specified.[ 'Switch-1','Switch-2' ]
elements

List of elements of nodes for which Outages are defined. The element must be defined to match the one which may occur in the events.

element_name must be either a string or a regex pattern (regex:pattern  or iregex:pattern as shown in examples)

element_name can be either interface name or other.

 [ {
  "element_name": "Vlan2", 
  "node_name": "Switch-1" 
  }, 
  {
   "element_name": "iregex:^Vlan.*?$", 
   "node_name": "Switch-2" 
} ]
 

 [ {
  "node_name": "Switch-1" 
  },
  {
   "element_name": "regex:^Vlan.*?$", 
   "node_name": "Switch-2" 
 }
 
 ]
options

optional key=values to adjust NMIS behaviour during an outage.

DOCUMENT THE KEYS AND VALUES

"Normal"

Limitations

API Endpoint

All requests are made under the following base URL:

...