Updating an alert suppression window

POST https://{{base_url}}/v6/alert-suppression-windows/{{alertSuppressionWindowId}}/update.json

Updating an alert suppression window

Updates an alert suppression window in ThousandEyes, based on properties provided in the POST data. In order to modify an alert suppression window, the user attempting the update must be an Account Admin.

Regular users are blocked from using any of the POST-based methods.

Optional (Querystring) Parameters

• format=json|xml optional, specifies the format of output requested. See Output Formats for more information
• aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

• {alertSuppressionWindowId} corresponds to the id of an alertSuppressionWindow, see the alert suppression window list endpoint for a listing of alert suppression windows.
• Request body containing the following fields
  • alertSuppressionWindowName string name of the alert suppression window
  • enabled bit n/a 0 for disabled, 1 for enabled
  • tests array of {“testId”: testId} objects List of tests assigned to the alert suppression window: [{“testId”: 123}, {“testId”: 456}]
  • startDateTime dateTime yyyy-MM-dd hh:mm:ss the date/time when the alert suppression window will start.
  • timezone string timezone name, in Area/Location format, as specified in the IANA TZDB.
  • duration integer seconds number of seconds for which the suppression window will be active
  • repeat repeat object see repeat options found below
  • repeat.type string [DAY, WEEK, MONTH, CUSTOM]
  • repeat.intervalType string n/a [DAY, WEEK, MONTH]
  • repeat.intervalLength integer n/a number of intervalTypes to wait before reactivating the alert suppression window.
  • repeat.daysOfWeek string n/a Specify which day of the week the alert suppression window needs to be activated for. Only valid for intervalType = WEEK. [SUN, MON, TUE, WED, THU, FRI, SAT]
  • endRepeat repeat object n/a see endRepeat options found below
  • endRepeat.type string n/a [COUNT, NEVER, DATE]
  • endRepeat.count integer n/a end repeat after number of occurrences (only valid with COUNT type option)
  • endRepeat.date date yyyy-MM-dd end repeat after specific date (only valid with DATE type option)

Request Body

{"alertSuppressionWindowName"=>"Postman DevNet 30 min asw created via API", "enabled"=>1, "startDateTime"=>"2020-01-01 00:00:00", "timezone"=>"Europe/Amsterdam", "duration"=>1800, "repeat"=>{"type"=>"DAY"}, "endRepeat"=>{"type"=>"NEVER"}}

HEADERS