{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mist Admins Sites Alarms API",
    "version": "2606.1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Sites Alarms",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "AckSiteMultipleAlarms",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/alarms/ack",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Ack multiple Site Alarms"
        },
        {
          "info": {
            "name": "ackSiteAllAlarms",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/alarms/ack_all",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Ack all Site Alarms\n\n**N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000."
        },
        {
          "info": {
            "name": "countSiteAlarms",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/sites/:site_id/alarms/count",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "distinct",
                "value": "",
                "type": "query",
                "description": "Field used to group this count response. enum: `acked`, `group`, `severity`, `type`"
              },
              {
                "name": "ack_admin_name",
                "value": "",
                "type": "query",
                "description": "Name of the admins who have acked the alarms; accepts multiple values separated by comma"
              },
              {
                "name": "acked",
                "value": "",
                "type": "query",
                "description": "Filter alarm results by whether the alarm has been acknowledged"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Key-name of the alarms; accepts multiple values separated by comma"
              },
              {
                "name": "severity",
                "value": "",
                "type": "query",
                "description": "Alarm severity; accepts multiple values separated by comma"
              },
              {
                "name": "group",
                "value": "",
                "type": "query",
                "description": "Alarm group name; accepts multiple values separated by comma"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`"
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`"
              },
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page"
              }
            ]
          },
          "docs": "Count alarms for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org Alarms](/#operations/countOrgAlarms) to count alarms across the organization."
        },
        {
          "info": {
            "name": "searchSiteAlarms",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/sites/:site_id/alarms/search",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "group",
                "value": "",
                "type": "query",
                "description": "Alarm group used to filter alarm results. enum: `certificate_expiry`, `infrastructure`, `marvis`, `security`. The `marvis` group is used to retrieve AI-driven network issue detections. Known Marvis alarm types include: `bad_cable`, `bad_wan_uplink`, `dns_failure`, `arp_failure`, `auth_failure`, `dhcp_failure`, `missing_vlan`, `negotiation_mismatch`, `port_flap`. Results include resolution status (`status`, `resolved_time`) and affected entity details."
              },
              {
                "name": "severity",
                "value": "",
                "type": "query",
                "description": "Alarm severity used to filter results. enum: `critical`, `info`, `warn`"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter alarms by alarm type. Accepts multiple values separated by comma. Use [List Alarm Definitions](/#operations/listAlarmDefinitions) to get the list of possible alarm types"
              },
              {
                "name": "ack_admin_name",
                "value": "",
                "type": "query",
                "description": "Name of the admins who have acked the alarms; accepts multiple values separated by comma"
              },
              {
                "name": "acked",
                "value": "",
                "type": "query",
                "description": "Filter alarm results by whether the alarm has been acknowledged"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`"
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`"
              },
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "On which field the list should be sorted, -prefix represents DESC order"
              },
              {
                "name": "search_after",
                "value": "",
                "type": "query",
                "description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
              }
            ]
          },
          "docs": "Search alarms for a site with filters for alarm group, severity, type, acknowledgement state, acknowledgement admin, and time range. Use [Search Org Alarms](/#operations/searchOrgAlarms) to search alarms across the organization."
        },
        {
          "info": {
            "name": "unackSiteMultipleAlarms",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/alarms/unack",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unack multiple Site Alarms"
        },
        {
          "info": {
            "name": "unackSiteAllAlarms",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/alarms/unack_all",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unack all Site Alarms\n\n**N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000."
        },
        {
          "info": {
            "name": "ackSiteAlarm",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/alarms/:alarm_id/ack",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "alarm_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Ack Site Alarm"
        },
        {
          "info": {
            "name": "unackSiteAlarm",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/alarms/:alarm_id/unack",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "alarm_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unack Site Alarm"
        },
        {
          "info": {
            "name": "SubscribeSiteAlarms",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/subscriptions",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Subscribe to Site Alarms"
        },
        {
          "info": {
            "name": "UnsubscribeSiteAlarms",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mist.com/api/v1/sites/:site_id/subscriptions",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Unsubscribe to Site Alarms"
        }
      ]
    }
  ],
  "bundled": true
}