How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mist Orgs Alarm Templates API

An Alarm Template is a set of Alarm Rules that could be applied toone or more sites (while each site can only pick one Alarm Template), or to thewhole org.Once created, the Alarm template must be assigned with the `alarmtemplate_id` attribute to one of the following* the whole org with the [Update Org](/#operations/updateOrg) API Call* one or multiple sites with the [Update Site Info](/#operations/updateSiteInfo) API Call

Mist Orgs Alarm Templates API is one of 212 APIs that Mist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orgs Alarm Templates. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 3 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 2606.1.1.

Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.

8 operations 3 paths 23 schemas 2 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2606.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Mist Orgs Alarm Templates API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…

Paths & Operations 8

Across 3 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orgs Alarm Templates 8

An Alarm Template is a set of Alarm Rules that could be applied to one or more sites (while each site can only pick one Alarm Template), or to the whole org. Once created, the Ala…

GET
/api/v1/orgs/{org_id}/alarmtemplates
listOrgAlarmTemplates
listOrgAlarmTemplates 3 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/alarmtemplates
createOrgAlarmTemplate
createOrgAlarmTemplate 1 param body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/alarmtemplates/suppress
unsuppressOrgSuppressedAlarms
unsuppressOrgSuppressedAlarms 1 param → 200400401403404429
GET
/api/v1/orgs/{org_id}/alarmtemplates/suppress
listOrgSuppressedAlarms
listOrgSuppressedAlarms 2 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/alarmtemplates/suppress
suppressOrgAlarm
suppressOrgAlarm 1 param body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/alarmtemplates/{alarmtemplate_id}
deleteOrgAlarmTemplate
deleteOrgAlarmTemplate 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/alarmtemplates/{alarmtemplate_id}
getOrgAlarmTemplate
getOrgAlarmTemplate 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/alarmtemplates/{alarmtemplate_id}
updateOrgAlarmTemplate
updateOrgAlarmTemplate 2 params body → 200400401403404429

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are alarm_template (7 properties), response_org_suppress_alarm_item (5 properties), suppressed_alarm (4 properties), delivery (4 properties). Each schema is shown below with its type and property counts.

response_http403
object
Standard HTTP 403 permission error response
1 property
suppressed_alarm
object
Request body for suppressing organization alarms
4 properties
org_id
string
Unique identifier of a Mist organization
response_http400
object
Standard HTTP 400 bad request error response
1 property
alarm_template_rule
object
Per-alarm enablement and delivery override in an alarm template
2 properties
suppressed_alarm_applies_site_ids
array
List of UUID of the sites within the org (if provided, the alarms will be suppressed for all the mentioned sites under the org)
response_org_suppress_alarm_item
object
Suppressed alarm entry for an organization or site alarm scope
5 properties
response_org_suppress_alarm_results
array
Suppressed alarm entries returned for the organization
delivery_additional_emails
array
List of additional email string to deliver the alarms via emails
modified_time
number
When the object has been modified for the last time, in epoch
suppressed_alarm_applies_sitegroup_ids
array
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)
response_http404
object
Standard HTTP 404 not found error response
1 property
alarm_templates
array
List of alarm templates
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
alarm_template
object
Alarm template defining default delivery and per-alarm rules
7 properties 2 required
id
string
Unique ID of the object instance in the Mist Organization
response_org_suppress_alarm
object
Response containing currently suppressed organization alarm entries
1 property
site_id
string
Unique identifier of a Mist site
created_time
number
When the object has been created, in epoch
suppressed_alarm_applies
object
If scope==site. Object defines the scope (within the org e.g. whole org, and/or some sitegroups, and/or some sites) for which the alarm service has to be suppr…
3 properties
suppressed_alarm_scope
string
level of scope. enum: org, site
delivery
object
Delivery object to configure the alarm delivery
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-orgs-alarm-templates-api-openapi.yml Raw ↑

Other APIs Mist publishes across the network.

Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
Where this information came from

This is an independent, third-party profile of Mist Orgs Alarm Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.