createOrgAlarmTemplate
POST https://{{host}}/api/v1/orgs/:org_id/alarmtemplates
Available rules can be found in Orgs>Consts>getAlarmDefs
The delivery dict is only required if different from the template delivery settings.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| org_id | string | path |
| name | string | Some string to name the alarm template |
| delivery | object | Delivery object to configure the alarm delivery |
| rules | object | Alarm Rules object to configure the individual alarm keys/types |
Delivery Parameters
| Parameter | Type | Description |
|---|---|---|
| enabled | boolean | Whether to enable the alarm delivery via emails or not |
| toorgadmins | boolean | Whether to deliver the alarms via emails to Org admins or not |
| tositeadmins | boolean | Whether to deliver the alarms via emails to Site admins or not |
| additional_emails | list | List of additional email string to deliver the alarms via emails |
Rules Parameters
| Parameter | Type | Description |
|---|---|---|
| object | Object to configure an individual Alarm (e.g. switch_down, device_down, device_restarted etc.) | |
| enabled | boolean | Whether to enable a particular alarm or not |
| delivery | object | Per-alarm specific delivery configuration object (required if configuration must be different than the Alarm Template level delivery object) |
Request Body
{"name"=>"Global", "delivery"=>{"enabled"=>false, "to_org_admins"=>true, "to_site_admins"=>true}, "rules"=>{"switch_down"=>{"enabled"=>true}, "device_down"=>{"enabled"=>true, "delivery"=>{"enabled"=>false, "to_org_admins"=>true, "to_site_admins"=>true}}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
X-CSRFToken | string | ||
Content-Type | string |
RESPONSES
status: OK
{"id":"684dfc5c-fe77-2290-eb1d-ef3d677fe168","name":"Global","delivery":{"enabled":false,"to_org_admins":true,"to_site_admins":true,"additional_emails":[]},"rules":{"switch_down":{"enabled":true},"device_down":{"enabled":true,"delivery":{"enabled":false,"to_org_admins":true,"to_site_admins":true,"additional_emails":[]}}}}