...

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
`current`	If the outage is current or scheduled/future outage. IS THIS 'current' for scheduled or null for future.	current
`description`	Long description of an Outage.	This is a test outage
`frequency`	Frequency 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
`end`	Date 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
`nodes`	List 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:

...