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 Sites Alarms API

Alarms are triggered based on certain events. Alarms could be configured using an [Orgs Alarm Template]($h/Orgs%20Alarm%20Templates/_overview).

Juniper Mist AI Sites Alarms 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 Sites Alarms. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 9 paths, and defines 28 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.

10 operations 9 paths 28 schemas 1 DELETE2 GET7 POST

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 Sites Alarms 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 10

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

Sites Alarms 10

Alarms are triggered based on certain events. Alarms could be configured using an [Orgs Alarm Template]($h/Orgs%20Alarm%20Templates/overview).

POST
/api/v1/sites/{site_id}/alarms/ack
AckSiteMultipleAlarms
AckSiteMultipleAlarms 1 param body → 200400401403404429
POST
/api/v1/sites/{site_id}/alarms/ack_all
ackSiteAllAlarms
ackSiteAllAlarms 1 param body → 200400401403404429
GET
/api/v1/sites/{site_id}/alarms/count
countSiteAlarms
countSiteAlarms 11 params → 200400401403404429
GET
/api/v1/sites/{site_id}/alarms/search
searchSiteAlarms
searchSiteAlarms 12 params → 200400401403404429
POST
/api/v1/sites/{site_id}/alarms/unack
unackSiteMultipleAlarms
unackSiteMultipleAlarms 1 param body → 200400401403404429
POST
/api/v1/sites/{site_id}/alarms/unack_all
unackSiteAllAlarms
unackSiteAllAlarms 1 param body → 200400401403404429
POST
/api/v1/sites/{site_id}/alarms/{alarm_id}/ack
ackSiteAlarm
ackSiteAlarm 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/alarms/{alarm_id}/unack
unackSiteAlarm
unackSiteAlarm 2 params body → 200400401403404429
DELETE
/api/v1/sites/{site_id}/subscriptions
UnsubscribeSiteAlarms
UnsubscribeSiteAlarms 1 param → 200400401403404429
POST
/api/v1/sites/{site_id}/subscriptions
SubscribeSiteAlarms
SubscribeSiteAlarms 1 param → 200400401403404429

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are alarm (22 properties), alarm_search_result (8 properties), response_count (6 properties), alarm_ack (2 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_count
object
6 properties 6 required
alarm_bssids
array
List of BSSIDs
response_http403
object
1 property
alarm_ack
object
2 properties 1 required
count_results
array
alarm_switches
array
additional information: List of MACs of the switches
count_result
object
1 property 1 required
site_id
string
response_http404
object
1 property
timestamp
number
Epoch (seconds)
alarm_hostnames
array
additional information: List of Hostnames of the devices (AP/Switch/Gateway)
alarm_status
string
enum: open, resolved
response_http400
object
1 property
note_string
object
1 property
alarm_severity
string
Severity of the alarm. enum: critical, info, warn
response_http429
object
1 property
alarm_gateways
array
additional information: List of MACs of the gateways
alarm_ssids
array
List of SSIDs
alarm_group
string
Alarm group. enum: infrastructure, marvis, security
alarm_count_distinct
string
enum: acked, group, severity, type
alarm
object
Additional information per alarm type
22 properties 7 required
alarm_aps
array
additional information: List of MACs of the APs
alarm_search_result
object
8 properties 5 required
alarm_ack_alarm_ids
array
alarm_search_results
array
response_http401
object
1 property
org_id
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-sites-alarms-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