Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsAlarm Templates

listOrgAlarmTemplates

GET
/api/v1/orgs/{org_id}/alarmtemplates

List alarm templates defined for the organization, including default delivery settings and per-alarm rule configuration.

Authorization

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
Formatuuid

Query Parameters

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/alarmtemplates"
[  {    "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      }    }  }]

createOrgAAMWProfile PUT

Update an organization Advanced Anti Malware profile's Sky ATP verdict threshold, actions, or file-category rules.

createOrgAlarmTemplate POST

Create an organization alarm template that defines default delivery settings and per-alarm rule overrides. Available rules can be found in [List Alarm Definitions](/api/mist/constants/constants-events/listAlarmDefinitions) 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](/api/mist/sites/updateSiteInfo) endpoint and specify the Alarm template ID in the `alarmtemplate_id` field of the request body.