suppressOrgAlarmTemplate

POST https://{{host}}/api/v1/orgs/:org_id/alarmtemplates/suppress

In certain situations, for example, scheduled maintenance, you may want to suspend alarms to be triggered against Sites for a period of time.

Body Parameters

NameTypeDescription
durationintduration, in seconds. Default is 3600. Maximum duration is 86400 * 180 (180 days). 0 is to un-suppress alarms.
scheduled_timeintepoch_time in seconds, Default as now, accepted time range is from now to now + 7 days.
scopestringlevel of scope, either org or site, default is site.
appliesobjectObject defines the scope (within the org e.g. whole org, and/or some site-groups, and/or some sites) for which the alarm service has to be suppressed for some duration
org_idstringUUID of the current org (if provided, the alarms will be suppressed at org level)
sitegroups_idsstringList of UUID of the site groups within the org (if provided, the alarms will be suppressed for all the sites under those site groups)
site_idsstringList of UUID of the sites within the org (if provided, the alarms will be suppressed for all the mentioned sites under the org)

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
X-CSRFTokenstring
Content-Typestring