Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Mist AI 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

Juniper Mist AI Orgs Alarm Templates API is one of 211 APIs that Juniper Mist AI 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 and API documentation.

This API exposes 8 operations across 3 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 2604.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.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Orgs Alarm Templates API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…
  • basicAuth — While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
  • csrfToken — This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…

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), delivery (4 properties), suppressed_alarm (4 properties). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
response_org_suppress_alarm_item
object
5 properties
response_http403
object
1 property
response_org_suppress_alarm
object
1 property
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_org_suppress_alarm_results
array
site_id
string
response_http404
object
1 property
alarm_template_rule
object
2 properties
response_http400
object
1 property
delivery_additional_emails
array
List of additional email string to deliver the alarms via emails
delivery
object
Delivery object to configure the alarm delivery
4 properties 1 required
response_http429
object
1 property
alarm_template
object
Alarm Template
7 properties 2 required
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)
suppressed_alarm
object
4 properties
suppressed_alarm_scope
string
level of scope. enum: org, site
response_http401
object
1 property
alarm_templates
array
org_id
string
modified_time
number
When the object has been modified for the last time, in epoch
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API