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 Clients - Wireless API

Wireless Clients are Wi-Fi devices connected to a Juniper Mist Access Point.

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

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

7 operations 7 paths 49 schemas 7 GET

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 Clients - Wireless 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 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Sites Clients - Wireless 7

Wireless Clients are Wi-Fi devices connected to a Juniper Mist Access Point.

GET
/api/v1/sites/{site_id}/clients/count
countSiteWirelessClients
countSiteWirelessClients 14 params → 200400401403404429
GET
/api/v1/sites/{site_id}/clients/events/count
countSiteWirelessClientEvents
countSiteWirelessClientEvents 13 params → 200400401403404429
GET
/api/v1/sites/{site_id}/clients/events/search
searchSiteWirelessClientEvents
searchSiteWirelessClientEvents 15 params → 200400401403404429
GET
/api/v1/sites/{site_id}/clients/search
searchSiteWirelessClients
searchSiteWirelessClients 21 params → 200400401403404429
GET
/api/v1/sites/{site_id}/clients/sessions/count
countSiteWirelessClientSessions
countSiteWirelessClientSessions 14 params → 200400401403404429
GET
/api/v1/sites/{site_id}/clients/sessions/search
searchSiteWirelessClientSessions
searchSiteWirelessClientSessions 18 params → 200400401403404429
GET
/api/v1/sites/{site_id}/clients/{client_mac}/events
getSiteEventsForClient
getSiteEventsForClient 13 params → 200400401403404429

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are client_wireless (40 properties), response_client_sessions_search_item (13 properties), events_client (12 properties), response_client_sessions_search (6 properties). Each schema is shown below with its type and property counts.

events_client
object
Client events
12 properties 2 required
response_client_sessions_search_results
array
client_wireless_ap
array
List of AP MAC Addresses the client was connected to
dot11_proto
string
enum: a, ac, ax, b, be, g, n
client_wireless_os_version
array
Only when client is having the Marvis Client app running. List of OS version detected for the client
site_client_events_count_distinct
string
enum: band, channel, proto, ssid, type, wlanid
response_client_sessions_search
object
6 properties 5 required
timestamp
number
Epoch (seconds)
response_client_events_search
object
6 properties 5 required
site_client_sessions_count_distinct
string
enum: ap, clientfamily, clientmanufacture, clientmodel, clientos, mac, ssid, wlanid
client_wireless_ssid
array
List of the WLAN names the client was connected to
response_http401
object
1 property
client_wireless_site_ids
array
List of Mist Site IDs where the client was connected
site_clients_count_distinct
string
enum: ap, device, hostname, ip, model, os, ssid, vlan
response_count
object
6 properties 6 required
last_username
string
If dot1x authentication, the username used during the latest authentication. Otherwise, the MAC address of the client
client_wireless_hostname
array
List of hostname detected for this client
response_client_sessions_search_item
object
13 properties 12 required
last_client_ip
string
The last known IP Address for the client
response_client_events_search_results
array
response_client_sessions_search_item_tags
array
client_wireless
object
40 properties
client_wireless_vlan
array
List of vlans that have been assigned to the client
response_client_search_results
array
response_events_search_results
array
count_result
object
1 property 1 required
last_vlan
integer
Latest VLAN ID assigned to the client
client_wireless_sdk_version
array
Only when client has the Marvis Client app running. List of Marvis Client SDK version detected for the client
response_events_search
object
6 properties 5 required
last_device
string
Latest type of device we identified (e.g. iPhone, Mac, ...)
response_http429
object
1 property
client_wireless_device
array
Only when client has the Marvis Client app running. List of the type of device type detected
client_key_mgmt
string
Key management protocol used for the latest authentication. enum: WPA2-PSK, WPA2-PSK-FT, WPA2-PSK-SHA256, WPA3-EAP-SHA256, WPA3-SAE-FT, WPA3-SAE-PSK
org_id
string
client_wireless_psk_id
array
List of IDs of the PPSK used by the client
client_wireless_ip
array
List if the ip addresses detected for this client
last_ap
string
Latest AP where the client is/was connected to
client_wireless_username
array
Only for 802.1X authentication. List of usernames used by the client
response_http403
object
1 property
client_wireless_psk_name
array
List of names of the PPSK used by the client
count_results
array
response_client_search
object
6 properties 5 required
site_id
string
response_http404
object
1 property
client_wireless_os
array
Only when client is having the Marvis Client app running. List of OS detected for the client
response_http400
object
1 property
client_wireless_app_version
array
Only when client has the Marvis Client app running. List of the versions of the Marvis Client
client_wireless_wlan_id
array
List of IDs of WLANs the client was connected to
dot11_band
string
enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-sites-clients-wireless-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