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
Name | Type | Description |
---|---|---|
duration | int | duration, in seconds. Default is 3600. Maximum duration is 86400 * 180 (180 days). 0 is to un-suppress alarms. |
scheduled_time | int | epoch_time in seconds, Default as now, accepted time range is from now to now + 7 days. |
scope | string | level of scope, either org or site, default is site. |
applies | object | Object 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_id | string | UUID of the current org (if provided, the alarms will be suppressed at org level) |
sitegroups_ids | string | List 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_ids | string | List of UUID of the sites within the org (if provided, the alarms will be suppressed for all the mentioned sites under the org) |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string | ||
X-CSRFToken | string | ||
Content-Type | string |