{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mist Admins Sites Services API",
    "version": "2606.1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Sites Services",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "listSiteServicesDerived",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/sites/:site_id/services/derived",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "resolve",
                "value": "",
                "type": "query",
                "description": "Whether resolve the site variables"
              }
            ]
          },
          "docs": "Get the list of derived Services for a Site"
        },
        {
          "info": {
            "name": "countSiteServicePathEvents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/sites/:site_id/services/events/count",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "distinct",
                "value": "",
                "type": "query",
                "description": "Field used to group this count response. enum: `mac`, `model`, `policy`, `port_id`, `site_id`, `type`, `vpn_name`, `vpn_path`"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Event type, e.g. GW_SERVICE_PATH_DOWN"
              },
              {
                "name": "text",
                "value": "",
                "type": "query",
                "description": "Description of the event including the reason it is triggered"
              },
              {
                "name": "vpn_name",
                "value": "",
                "type": "query",
                "description": "Filter results by vpn name"
              },
              {
                "name": "vpn_path",
                "value": "",
                "type": "query",
                "description": "Filter results by vpn path"
              },
              {
                "name": "policy",
                "value": "",
                "type": "query",
                "description": "Service policy associated with that specific path"
              },
              {
                "name": "port_id",
                "value": "",
                "type": "query",
                "description": "Filter results by port identifier"
              },
              {
                "name": "model",
                "value": "",
                "type": "query",
                "description": "Filter results by device model"
              },
              {
                "name": "version",
                "value": "",
                "type": "query",
                "description": "Filter results by software version"
              },
              {
                "name": "mac",
                "value": "",
                "type": "query",
                "description": "Filter results by MAC address"
              },
              {
                "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 by Distinct Attributes of Service Path Events"
        },
        {
          "info": {
            "name": "searchSiteServicePathEvents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/sites/:site_id/services/events/search",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Event type, e.g. GW_SERVICE_PATH_DOWN"
              },
              {
                "name": "text",
                "value": "",
                "type": "query",
                "description": "Description of the event including the reason it is triggered"
              },
              {
                "name": "peer_port_id",
                "value": "",
                "type": "query",
                "description": "Port ID of the peer gateway"
              },
              {
                "name": "peer_mac",
                "value": "",
                "type": "query",
                "description": "MAC address of the peer gateway"
              },
              {
                "name": "vpn_name",
                "value": "",
                "type": "query",
                "description": "Filter results by vpn name"
              },
              {
                "name": "vpn_path",
                "value": "",
                "type": "query",
                "description": "Filter results by vpn path"
              },
              {
                "name": "policy",
                "value": "",
                "type": "query",
                "description": "Service policy associated with that specific path"
              },
              {
                "name": "port_id",
                "value": "",
                "type": "query",
                "description": "Filter results by port identifier"
              },
              {
                "name": "model",
                "value": "",
                "type": "query",
                "description": "Filter results by device model"
              },
              {
                "name": "version",
                "value": "",
                "type": "query",
                "description": "Filter results by software version"
              },
              {
                "name": "mac",
                "value": "",
                "type": "query",
                "description": "Filter results by MAC address"
              },
              {
                "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 Service Path Events"
        }
      ]
    }
  ],
  "bundled": true
}