AlertSite API operations for managing blackouts use the following data fields to represent the blackout configuration.
Blackouts are identified by id, and the associated monitor or recipient is specified by assoc_id.
| Field | Type | Description |
|---|---|---|
assoc_id |
Integer | Required. The ID of the monitor (if type=Monitor or Alert) or recipient (if type=Notifier) that is being blacked out. |
date_added |
String or null |
UTC date and time when the blackout was added, in the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). |
end_day |
Integer or null |
Used only with recurring (persistent) blackouts. Specifies the day of the week when the blackout ends: Sunday=1, Monday=2, and so on. One-time blackouts have |
end_time |
String or null |
Used only with recurring blackouts. Specifies the blackout end time (hh:mm). One-time blackouts have |
from_date |
String or null |
Used only with one-time blackouts. Specifies the start date and time of the blackout in the YYYY-MM-DD HH:MM:SS format, for example, 2018-11-06 13:00:00. Must be less than Recurring blackouts have |
id |
Integer | Read-only. Blackout ID. |
login |
String or null |
The email address of the user who created this blackout. |
note |
String or null |
Blackout notes, up to 255 characters. |
persistent |
Boolean | true means a recurring blackout, false means a one-time blackout. |
start_day |
Integer or null |
Used only with recurring blackouts. Specifies the day of the week when the blackout begins: Sunday=1, Monday=2, and so on. One-time blackouts have |
start_time |
String or null |
Used only with recurring blackouts. Specifies the blackout start time (hh:mm). One-time blackouts have |
thru_date |
String or null |
Used only with one-time blackouts. Specifies the end date and time of the blackout in the YYYY-MM-DD HH:MM:SS format, for example, 2018-11-06 15:30:00. Must be greater than Recurring blackouts have |
type |
String | Required. What is being blacked out:
The associated monitor or recipient ID is specified by |