createOrgAlarmTemplate
Create an organization alarm template that defines default delivery settings and per-alarm rule overrides. Available rules can be found in List Alarm Definitions
The delivery object is only required when it differs from the template delivery settings.
To assign an Alarm template to a site, use the Update Site endpoint and specify the Alarm template ID in the alarmtemplate_id field of the request body.
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
uuidRequest Body
application/json
Request Body
Alarm template defining default delivery and per-alarm rules
Default alarm delivery settings for rules in this template
Some string to name the alarm template
Alarm Rules object to configure the individual alarm keys/types. Property key is the alarm name.
Response Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/alarmtemplates" \ -H "Content-Type: application/json" \ -d '{ "delivery": { "enabled": true }, "rules": { "ap_offline": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "bad_cable": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true } } }'{ "created_time": 0.1, "delivery": { "additional_emails": [ "john@mycorp.com" ], "enabled": true, "to_org_admins": true, "to_site_admins": false }, "id": "53f10664-3ce8-4c27-b382-0ef66432349f", "modified_time": 0.1, "name": "default", "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61", "rules": { "ap_offline": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true }, "bad_cable": { "delivery": { "additional_emails": [ "string" ], "enabled": true, "to_org_admins": true, "to_site_admins": true }, "enabled": true } }}