{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mist Admins Orgs Clients - Wireless API",
    "version": "2606.1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Orgs Clients - Wireless",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "countOrgWirelessClients",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/clients/count",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "distinct",
                "value": "",
                "type": "query",
                "description": "Field used to group this count response. enum: `ap`, `device`, `hostname`, `ip`, `mac`, `model`, `os`, `ssid`, `vlan`"
              },
              {
                "name": "mac",
                "value": "",
                "type": "query",
                "description": "Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported. Accepts multiple comma-separated values."
              },
              {
                "name": "hostname",
                "value": "",
                "type": "query",
                "description": "Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported. Accepts multiple comma-separated values."
              },
              {
                "name": "device",
                "value": "",
                "type": "query",
                "description": "Filter results by device type"
              },
              {
                "name": "os",
                "value": "",
                "type": "query",
                "description": "Filter results by operating system"
              },
              {
                "name": "model",
                "value": "",
                "type": "query",
                "description": "Filter results by device model"
              },
              {
                "name": "ap",
                "value": "",
                "type": "query",
                "description": "Filter results by AP MAC address"
              },
              {
                "name": "vlan",
                "value": "",
                "type": "query",
                "description": "Filter results by VLAN ID"
              },
              {
                "name": "ssid",
                "value": "",
                "type": "query",
                "description": "Filter results by SSID"
              },
              {
                "name": "ip",
                "value": "",
                "type": "query",
                "description": "Filter results by IPv4 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 wireless client records across the organization, optionally grouped by `distinct` and filtered by client identity, AP, SSID, VLAN, IP, and time range."
        },
        {
          "info": {
            "name": "countOrgWirelessClientEvents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/clients/events/count",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "distinct",
                "value": "type",
                "type": "query",
                "description": "Field used to group this count response. enum: `band`, `channel`, `proto`, `ssid`, `type`, `wlan_id`"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions). Accepts multiple comma-separated values."
              },
              {
                "name": "reason_code",
                "value": "",
                "type": "query",
                "description": "Reason code filter for association and disassociation events"
              },
              {
                "name": "ssid",
                "value": "",
                "type": "query",
                "description": "Filter results by SSID"
              },
              {
                "name": "ap",
                "value": "",
                "type": "query",
                "description": "Filter results by AP MAC address"
              },
              {
                "name": "proto",
                "value": "",
                "type": "query",
                "description": "802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`"
              },
              {
                "name": "band",
                "value": "",
                "type": "query",
                "description": "802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`"
              },
              {
                "name": "wlan_id",
                "value": "",
                "type": "query",
                "description": "Filter results by WLAN identifier"
              },
              {
                "name": "site_id",
                "value": "",
                "type": "query",
                "description": "Filter results by site identifier"
              },
              {
                "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 wireless client event records across the organization, optionally grouped by event attributes and filtered by event type, WLAN, radio, site, and time range."
        },
        {
          "info": {
            "name": "searchOrgWirelessClientEvents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/clients/events/search",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions). Accepts multiple comma-separated values."
              },
              {
                "name": "reason_code",
                "value": "",
                "type": "query",
                "description": "Reason code filter for association and disassociation events. Accepts multiple comma-separated integer values."
              },
              {
                "name": "ssid",
                "value": "",
                "type": "query",
                "description": "Filter results by SSID. Accepts multiple comma-separated values."
              },
              {
                "name": "ap",
                "value": "",
                "type": "query",
                "description": "Filter results by AP MAC address. Accepts multiple comma-separated values."
              },
              {
                "name": "key_mgmt",
                "value": "WPA2-PSK,WPA2-PSK/CCMP",
                "type": "query",
                "description": "Key management protocol used to filter client events. enum: `WPA2-PSK`, `WPA2-PSK/CCMP`, `WPA2-PSK-FT`, `WPA2-PSK-SHA256`, `WPA3-EAP-SHA256`, `WPA3-EAP-SHA256/CCMP`, `WPA3-EAP-FT/GCMP256`, `WPA3-SAE-FT`, `WPA3-SAE-PSK`. Accepts multiple comma-separated values."
              },
              {
                "name": "proto",
                "value": "ax,ac",
                "type": "query",
                "description": "802.11 protocol used to filter results. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`. Accepts multiple comma-separated values."
              },
              {
                "name": "band",
                "value": "6,5",
                "type": "query",
                "description": "802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`. Accepts multiple comma-separated values."
              },
              {
                "name": "wlan_id",
                "value": "",
                "type": "query",
                "description": "Filter results by WLAN identifier"
              },
              {
                "name": "nacrule_id",
                "value": "",
                "type": "query",
                "description": "Filter results by NAC rule identifier. Accepts multiple comma-separated values."
              },
              {
                "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": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page"
              },
              {
                "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 wireless client event records across the organization with filters for event type, reason code, SSID, AP, key management, protocol, band, WLAN, NAC rule, and time range."
        },
        {
          "info": {
            "name": "searchOrgWirelessClients",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/clients/search",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "site_id",
                "value": "",
                "type": "query",
                "description": "Filter results by site identifier"
              },
              {
                "name": "ap",
                "value": "",
                "type": "query",
                "description": "Filter results by AP MAC address"
              },
              {
                "name": "band",
                "value": "",
                "type": "query",
                "description": "Comma separated list of Radio band (e.g. `24,5`). enum: `24`, `5`, `6`"
              },
              {
                "name": "device",
                "value": "",
                "type": "query",
                "description": "Comma separated list of Device type (e.g. `Mac,iPhone`). Case sensitive"
              },
              {
                "name": "hostname",
                "value": "",
                "type": "query",
                "description": "Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported. Accepts multiple comma-separated values."
              },
              {
                "name": "ip",
                "value": "",
                "type": "query",
                "description": "Partial / full Client IP address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported. Accepts multiple comma-separated values."
              },
              {
                "name": "mac",
                "value": "",
                "type": "query",
                "description": "Partial / full Client MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported. Accepts multiple comma-separated values."
              },
              {
                "name": "model",
                "value": "",
                "type": "query",
                "description": "Only available for clients running the Marvis Client app, model, e.g. \"MBP 15 late 2013\", 6, 6s, \"8+ GSM\""
              },
              {
                "name": "os",
                "value": "",
                "type": "query",
                "description": "Only available for clients running the Marvis Client app, os, e.g. Sierra, Yosemite, Windows 10"
              },
              {
                "name": "psk_id",
                "value": "",
                "type": "query",
                "description": "PSK identifier used to filter the results"
              },
              {
                "name": "psk_name",
                "value": "",
                "type": "query",
                "description": "Only available for clients using PPSK authentication, the Name of the PSK"
              },
              {
                "name": "ssid",
                "value": "",
                "type": "query",
                "description": "Filter results by SSID"
              },
              {
                "name": "text",
                "value": "",
                "type": "query",
                "description": "Partial / full MAC address, hostname, username, psk_name or ip. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported"
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "Partial / full username. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `johndoe*` and `*mycorp*` match `johndoe@mycorp.com`). Suffix-only wildcards (e.g. `*mycorp.com`) are not supported. Accepts multiple comma-separated values."
              },
              {
                "name": "vlan",
                "value": "",
                "type": "query",
                "description": "Filter results by VLAN ID"
              },
              {
                "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 wireless client records across the organization with filters for site, AP, band, device identity, hostname, IP, MAC address, username, SSID, PPSK, VLAN, and time range."
        },
        {
          "info": {
            "name": "countOrgWirelessClientsSessions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/clients/sessions/count",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "distinct",
                "value": "",
                "type": "query",
                "description": "Field used to group this count response. enum: `ap`, `device`, `hostname`, `ip`, `model`, `os`, `ssid`, `vlan`"
              },
              {
                "name": "ap",
                "value": "",
                "type": "query",
                "description": "Filter results by AP MAC address"
              },
              {
                "name": "band",
                "value": "",
                "type": "query",
                "description": "802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`"
              },
              {
                "name": "client_family",
                "value": "",
                "type": "query",
                "description": "E.g. \"Mac\", \"iPhone\", \"Apple watch\""
              },
              {
                "name": "client_manufacture",
                "value": "",
                "type": "query",
                "description": "Filter results by client manufacturer, e.g. \"Apple\""
              },
              {
                "name": "client_model",
                "value": "",
                "type": "query",
                "description": "Filter results by client model, e.g. \"8+\", \"XS\""
              },
              {
                "name": "client_os",
                "value": "",
                "type": "query",
                "description": "E.g. \"Mojave\", \"Windows 10\", \"Linux\""
              },
              {
                "name": "ssid",
                "value": "",
                "type": "query",
                "description": "Filter results by SSID"
              },
              {
                "name": "wlan_id",
                "value": "",
                "type": "query",
                "description": "Filter results by WLAN identifier"
              },
              {
                "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 historical wireless client sessions across the organization, optionally grouped by `distinct` and filtered by AP, band, client attributes, SSID, WLAN, and time range."
        },
        {
          "info": {
            "name": "searchOrgWirelessClientSessions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/clients/sessions/search",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "ap",
                "value": "",
                "type": "query",
                "description": "Filter results by AP MAC address"
              },
              {
                "name": "band",
                "value": "5,6",
                "type": "query",
                "description": "802.11 band used to filter radio results. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`. Accepts multiple comma-separated values."
              },
              {
                "name": "client_family",
                "value": "",
                "type": "query",
                "description": "E.g. \"Mac\", \"iPhone\", \"Apple watch\". Accepts multiple comma-separated values."
              },
              {
                "name": "client_manufacture",
                "value": "",
                "type": "query",
                "description": "Filter results by client manufacturer, e.g. \"Apple\". Accepts multiple comma-separated values."
              },
              {
                "name": "client_model",
                "value": "",
                "type": "query",
                "description": "Filter results by client model, e.g. \"8+\", \"XS\". Accepts multiple comma-separated values."
              },
              {
                "name": "client_username",
                "value": "",
                "type": "query",
                "description": "Filter results by client username. Accepts multiple comma-separated values."
              },
              {
                "name": "client_os",
                "value": "",
                "type": "query",
                "description": "E.g. \"Mojave\", \"Windows 10\", \"Linux\". Accepts multiple comma-separated values."
              },
              {
                "name": "ssid",
                "value": "",
                "type": "query",
                "description": "Filter results by SSID. Accepts multiple comma-separated values."
              },
              {
                "name": "wlan_id",
                "value": "",
                "type": "query",
                "description": "Filter results by WLAN identifier"
              },
              {
                "name": "psk_id",
                "value": "",
                "type": "query",
                "description": "PSK identifier used to filter the results"
              },
              {
                "name": "psk_name",
                "value": "",
                "type": "query",
                "description": "Filter results by PSK name. Accepts multiple comma-separated values."
              },
              {
                "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 historical wireless client sessions across the organization with filters for AP, band, client family, manufacturer, model, OS, username, SSID, WLAN, PPSK, and time range."
        }
      ]
    }
  ],
  "bundled": true
}