OrgsAlarm Templates
suppressOrgAlarm
Create or schedule an alarm suppression window for the organization or selected sites, for example during planned maintenance.
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
org_id*string
Format
uuidRequest Body
application/json
Request body for suppressing organization alarms
applies?
If scope==site. Site and site-group targets where alarms are suppressed
duration?number
Suppression length, in seconds. Maximum duration is 86400 * 180 (180 days). 0 is to un-suppress alarms
Range
0 <= value <= 15552000Default
3600scheduled_time?integer
Time when alarm suppression starts, in epoch seconds. Defaults to now; accepted range is from now to now + 7 days
scope?suppressed_alarm_scope
Alarm suppression target level. enum: org, site.
Default
"site"Value in
- "org"
- "site"
Response Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/alarmtemplates/suppress" \ -H "Content-Type: application/json" \ -d '{ "duration": 3600, "scheduled_time": 1678232980, "scope": "org" }'Empty