Mist Mist API
The Mist API API from Mist — 0 operation(s) for mist api.
Mist Mist API is one of 212 APIs that Mist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Mist API. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 0 operations across 0 paths, and defines 185 schemas. It is described by OpenAPI 3.2.0, at version 2606.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.
0 operations
0 paths
185 schemas
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Mist Mist API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiToken).
An API key is passed in the header as X-CSRFToken (csrfToken).
By default, every request must be authenticated.
apiToken— Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…csrfToken— Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…
Schemas 185
The contract defines 185 schemas that model the data the API accepts and returns. The most detailed are device_event (30 properties), nac_client_event (28 properties), webhook_client_sessions_event (24 properties), webhook_guest_authorizations_event (20 properties). Each schema is shown below with its type and property counts.
webhook_location_centrak
object
Sample of the location-centrak webhook payload.
2 properties
2 required
webhook_nac_events
object
Sample of the nac-events webhook payload.
2 properties
webhook_location_topic
string
Webhook topic name for generic location deliveries. enum: location
nac_client_events
array
List of NAC authentication events
webhook_location_asset_topic
string
Webhook topic name for asset location deliveries. enum: location-asset
random_mac
string
Whether the client is using randomized MAC address or not. enum: true, false
webhook_rssizone_events
array
RSSI zone transition events included in a webhook delivery
webhook_minis_application
object
Sample of the minis-application webhook payload.
2 properties
2 required
webhook_wifi_conn_raw_events
array
Connected Wi-Fi raw packet events included in a webhook delivery
org_id
string
Unique identifier of a Mist organization
webhook_audits_topic
string
Webhook topic name for audit event deliveries. enum: audits
webhook_sdkclient_scan_data_event_scan_data_item
object
Single BSSID observation from an SDK client's background Wi-Fi scan
7 properties
7 required
webhook_minis_reachability_events
array
Marvis Minis reachability test events included in a webhook delivery
nac_event_nacrule_id
string
NAC Policy Rule ID, if matched
webhook_client_latency_topic
string
Webhook topic name for client latency deliveries. enum: client-latency
device_events
array
List of device event payloads
webhook_site_sle
object
Sample of the site-sle webhook payload.
2 properties
2 required
webhook_location_sdk_events
array
SDK client location events included in this webhook delivery
webhook_device_updowns
object
Sample of the device-updowns webhook payload.
2 properties
2 required
webhook_alarm_event_ssids
array
Representative wireless SSID samples included for an alarm webhook event
webhook_client_info_event
object
Client identity and addressing details delivered by a client-info webhook
6 properties
nac_client_event_usermac_labels
array
Labels derived from usermac entry
service_packets
array
List of service data packets heard from the asset/ beacon
nac_event_dryrun_nacrule_id
string
NAC Policy Dry Run Rule ID, if present and matched
last_seen
numbernull
Timestamp indicating when the entity was last seen
webhook_discovered_raw_rssi
object
Sample of the discovered-raw-rssi webhook payload.
2 properties
1 required
webhook_nac_accounting_events
array
NAC accounting events included in a webhook delivery
webhook_alarms_topic
string
Webhook topic name for alarm event deliveries. enum: alarms
webhook_zone_topic
string
Webhook topic name for zone transition deliveries. enum: zone
webhook_location_unclient
object
Sample of the location-unclient webhook payload.
2 properties
2 required
webhook_occupancy_alerts_topic
string
Webhook topic name for occupancy alert deliveries. enum: occupancy-alerts
webhook_location_centrak_event_type
string
Location object type for CenTrak Wi-Fi beacon events. enum: wifi
wifi_beacon_extended_info_items
object
Extended Wi-Fi beacon packet metadata with frame and sequence control fields
3 properties
webhook_alarm_event
object
Alarm event delivered inside an alarms webhook payload
14 properties
5 required
webhook_client_latency
object
Sample of the client-latency webhook payload.
2 properties
webhook_asset_raw_rssi_event_ap_loc
array
optional, coordinates (if any) of reporting AP (updated once in 60s per client)
webhook_wifi_conn_raw_event_extended_info_list
array
optional, list of specific telemetry packets emited by certain wifi tags (Eg. Centrak)
webhook_minis_reachability
object
Sample of the minis-reachability webhook payload.
2 properties
2 required
webhook_client_sessions_events
array
Client session events included in a webhook delivery
webhook_discovered_raw_rssi_event_ap_loc
array
coordinates (if any) of reporting AP (updated once in 60s per client)
webhook_location_unclient_topic
string
Webhook topic name for unconnected client location deliveries. enum: location-unclient
webhook_device_events_topic
string
Webhook topic name for device event deliveries. enum: device-events
nac_client_event_idp_role
array
Identity provider roles or groups returned for a NAC client event
webhook_site_sle_event
object
Site-level Wi-Fi SLE score snapshot
4 properties
webhook_rssizone
object
Sample of the rssizone webhook payload.
2 properties
2 required
ibeacon_minor
integernull
Minor number for iBeacon
webhook_sdkclient_scan_data_events
array
SDK client scan data events included in a webhook delivery
ibeacon_major
integernull
Major number for iBeacon
webhook_location_sdk
object
Sample of the location-sdk webhook payload.
2 properties
2 required
service_packet
object
Service data packet observed from an asset or beacon
2 properties
webhook_nac_accounting_topic
string
Webhook topic name for NAC accounting deliveries. enum: nac-accounting
webhook_guest_authorizations
object
Sample of the guest-authorizations webhook payload.
2 properties
webhook_asset_raw_rssi_event_service_packet
object
BLE service data decoded from an asset raw RSSI packet
2 properties
log_event
object
Audit log event recorded for an organization or site
12 properties
3 required
webhook_zone_events
array
Zone transition events included in this webhook delivery
ibeacon_uuid
stringnull
iBeacon UUID value, or null when no iBeacon UUID is configured
webhook_zone_event_trigger
string
Zone transition direction, either enter or exit. enum: enter, exit
device_event
object
Device event payload returned by search and webhook APIs
30 properties
3 required
webhook_wifi_conn_raw_event_extended_info
object
Extended telemetry details decoded from a connected Wi-Fi packet
3 properties
device_type
string
enum: ap, gateway, switch
nac_event_idp_id
string
If IDP is used, the id of the IDP configuration used
webhook_client_sessions_event
object
Wireless client session event delivered when a client roams or disconnects
24 properties
24 required
webhook_occupancy_alert_type
string
Occupancy compliance state reported for the zone. enum: COMPLIANCE-OK, COMPLIANCE-VIOLATION
webhook_occupancy_alerts_event_alert_events_items
object
Occupancy compliance alert for a single zone
8 properties
8 required
webhook_location_client
object
Sample of the location-client webhook payload.
2 properties
2 required
webhook_client_sessions_topic
string
Webhook topic name for client session deliveries. enum: client-sessions
webhook_asset_raw_rssi_event
object
Raw RSSI sample reported for an asset or beacon packet
16 properties
webhook_sdkclient_scan_data_event_scan_data
array
Background Wi-Fi scan observations reported by an SDK client
nac_auth_type
string
enum: cert, device-auth, eap-teap, eap-tls, eap-ttls, idp, mab, eap-peap
event_severity
string
Severity level for an event. enum: normal, critical, high, warning
webhook_zone
object
Sample of the zone webhook payload.
2 properties
2 required
webhook_device_updowns_events
array
Device up/down events included in a webhook delivery
webhook_alarm_event_aps
array
Representative AP MAC address samples included for an alarm webhook event
webhook_discovered_raw_rssi_topic
string
Webhook topic name for discovered raw RSSI deliveries. enum: discovered-raw-rssi
nac_client_event
object
NAC authentication event for a wired or wireless client
28 properties
webhook_location_centrak_events
array
CenTrak location events included in this webhook delivery
webhook_alarms
object
Sample of the alarms webhook payload. N.B.: Fields like aps, bssids, ssids are event specific. They are relevant to this event type ( rogue-ap-detected). For a…
2 properties
2 required
log_events
array
Audit log events returned by a log query
webhook_occupancy_alerts_event_alert_events
array
List of occupancy alerts for non-compliance zones within the site detected around the same time
webhook_rssizone_event
object
RSSI zone transition event for a Wi-Fi, SDK, or asset client
7 properties
7 required
nac_event_vlan
string
vlan that assigned to the client
webhook_wifi_conn_raw_event
object
Raw packet observation for a connected Wi-Fi client
9 properties
webhook_minis_application_events
array
Marvis Minis application test events included in a webhook delivery
webhook_mxedge_event_topic
string
Webhook topic name for Mist Edge event deliveries. enum: mxedge-events
nac_event_nacrule_matched
boolean
NAC Policy Rule Matched
webhook_occupancy_alerts_events
array
Occupancy alert batches included in a webhook delivery
webhook_occupancy_alerts_event
object
Site-level occupancy alert batch containing one or more zone alerts
4 properties
2 required
webhook_ping_events
array
Ping events included in a webhook delivery
webhook_wifi_unconn_raw_topic
string
Webhook topic name for unconnected Wi-Fi raw packet deliveries. enum: wifi-unconn-raw
webhook_ping_topic
string
Webhook topic name for ping deliveries. enum: ping
synthetictest_config_custom_probe_type
string
enum: application, curl, icmp, reachability, tcp
webhook_location_event
object
Generic location update with map coordinates and optional BLE or Wi-Fi metadata
19 properties
7 required
nac_event_type
string
Event type, e.g. NACCLIENTPERMIT. Use the [List NAC Events Definitions](/operations/listNacEventsDefinitions) endpoint to get the full list of available values.
mxedge_event_sys_info
object
System resource details for a Mist Edge event
2 properties
webhook_mxedge_events
object
Sample of the mxedge-events webhook payload.
2 properties
2 required
webhook_device_events
object
Sample of the device-events webhook payload.
2 properties
2 required
webhook_location_client_event
object
Connected Wi-Fi client location update with map coordinates
8 properties
rx_pkts
integernull
Amount of packets received since connection
nac_access_type
string
Type of network access. enum: wireless, wired, vty
webhook_device_updowns_topic
string
Webhook topic name for device up/down deliveries. enum: device-updowns
webhook_client_join_topic
string
Webhook topic name for client join deliveries. enum: client-join
timestamp
number
Epoch timestamp, in seconds
webhook_asset_raw_rssi_event_service_packets
array
BLE service data packets decoded from an asset raw RSSI event
webhook_nac_events_topic
string
Webhook topic name for NAC event deliveries. enum: nac-events
webhook_asset_raw_rssi_topic
string
Webhook topic name for asset raw RSSI deliveries. enum: asset-raw-rssi
webhook_location_client_topic
string
Webhook topic name for connected client location deliveries. enum: location-client
webhook_location_events
array
Location events included in this webhook delivery
webhook_guest_authorizations_topic
string
Webhook topic name for guest authorization deliveries. enum: guest-authorizations
ha_cluster_node_enum
string
HA cluster node selector. enum: node0, node1
webhook_wifi_unconn_raw_events
array
Unconnected Wi-Fi raw packet events included in a webhook delivery
mxedge_events
array
Mist Edge event records
webhook_wifi_conn_raw_event_packets
array
RSSI packet observations for a connected Wi-Fi raw event
webhook_sdkclient_scan_data
object
Sample of the sdkclient-scan-data webhook payload.
2 properties
2 required
nac_event_nas_vendor
string
Vendor name of the NAS
webhook_client_info
object
Sample of the client-info webhook payload.
2 properties
id
string
Unique ID of the object instance in the Mist Organization
nac_event_dryrun_nacrule_matched
boolean
true if dryrun rule present and matched with priority, false if not matched or not present
webhook_location_unclient_events
array
Unconnected client location events included in this webhook delivery
webhook_client_latency_event
object
Site-level client latency metrics for authentication, DHCP, and DNS operations
12 properties
webhook_minis_reachability_topic
string
Webhook topic name for Minis reachability test deliveries. enum: minis-reachability
webhook_occupancy_alerts
object
Sample of the occupancy-alerts webhook payload.
2 properties
2 required
wifi_beacon_extended_info
array
Optional, list of extended beacon info packets heard from the client, frame and sequence control included with the payload
webhook_zone_event_type
string
Type of client. enum: asset (BLE Tag), sdk, wifi
webhook_client_info_events
array
Client information events included in a webhook delivery
webhook_location_sdk_event
object
SDK client location update with map coordinates
8 properties
webhook_wifi_unconn_raw_event_ap_loc
array
optional, coordinates (if any) of reporting AP (updated once in 60s per client)
webhook_location_asset_event
object
Asset location update with map coordinates and optional BLE beacon metadata
16 properties
webhook_asset_raw_rssi
object
Sample of the asset-raw-rssi webhook payload. This webhook topic provides raw data from packets emitted by named and filtered assets. Raw data webhooks are a s…
2 properties
2 required
webhook_wifi_conn_raw_topic
string
Webhook topic name for connected Wi-Fi raw packet deliveries. enum: wifi-conn-raw
webhook_location_sdk_topic
string
Webhook topic name for SDK client location deliveries. enum: location-sdk
webhook_wifi_unconn_raw_event_packet
object
RSSI observation for an unconnected Wi-Fi client packet
2 properties
webhook_site_sle_event_sle
object
Wi-Fi SLE scores reported by a site SLE webhook event
3 properties
nac_device_mac
string
MAC address of the AP or switch the client is connected to
webhook_minis_reachability_event
object
Marvis Minis reachability synthetic test result
14 properties
webhook_wifi_conn_raw
object
Sample of the wifi-conn-raw webhook payload. This webhook topic provides raw data from packets emitted by connected devices. Raw data webhooks are a special su…
2 properties
2 required
webhook_location_asset_events
array
Asset location events included in this webhook delivery
webhook_minis_application_event
object
Marvis Minis application synthetic test result
12 properties
nac_event_port_id
string
Port ID where the NAC client event occurred
webhook_location_unclient_event
object
Unconnected Wi-Fi client location update with map coordinates
8 properties
webhook_asset_raw_rssi_events
array
Asset raw RSSI events included in a webhook delivery
nac_event_username
string
username assigned to the client
webhook_alarm_event_bssids
array
Representative BSSID samples included for an alarm webhook event
webhook_nac_accounting_event
object
NAC accounting event for a client session with traffic counters
15 properties
mxedge_event
object
Event reported for a Mist Edge appliance or service
18 properties
webhook_location
object
Sample of the location webhook payload.
2 properties
2 required
webhook_location_centrak_topic
string
Webhook topic name for CenTrak location deliveries. enum: location-centrak
webhook_discovered_raw_rssi_events
array
Discovered BLE raw RSSI events included in a webhook delivery
resp_attrs
array
List of RADIUS AVP returned by the Authentication Server
nac_client_mac
string
Client MAC address observed in the NAC event
webhook_wifi_conn_raw_event_packet
object
RSSI observation for a connected Wi-Fi client packet
2 properties
webhook_wifi_conn_raw_event_ap_loc
array
optional, coordinates (if any) of reporting AP (updated once in 60s per client)
webhook_sdkclient_scan_data_topic
string
Webhook topic name for SDK client scan data deliveries. enum: sdkclient-scan-data
webhook_client_join_event
object
Wireless client association event delivered when a client joins a WLAN
15 properties
15 required
webhook_site_sle_topic
string
Webhook topic name for site SLE score deliveries. enum: site-sle
webhook_discovered_raw_rssi_event
object
Raw RSSI sample reported for a passive BLE device packet
16 properties
7 required
webhook_wifi_unconn_raw_event_packets
array
RSSI packet observations for an unconnected Wi-Fi raw event
tx_pkts
integernull
Amount of packets sent since connection
webhook_ping_event
object
Ping webhook event generated to verify webhook delivery
4 properties
4 required
webhook_guest_authorizations_events
array
Guest authorization events included in this webhook delivery
webhook_nac_accounting
object
Sample of the nac-accounting webhook payload.
2 properties
webhook_device_updowns_event
object
Device availability event delivered when a monitored AP changes up/down state
8 properties
7 required
webhook_guest_authorizations_event
object
Guest portal authorization event with registration and WLAN context
20 properties
webhook_location_centrak_event
object
CenTrak location update with map coordinates and Wi-Fi beacon metadata
10 properties
site_id
string
Unique identifier of a Mist site
webhook_location_asset
object
Sample of the locationasset webhook payload.
2 properties
2 required
nac_event_idp_username
string
If IDP is used, the username presented to the Identity Provider
webhook_wifi_unconn_raw_event
object
Raw packet observation for an unconnected Wi-Fi client
8 properties
webhook_ping
object
Sample of the ping webhook payload.\n\nThe ping webhook can be manually sent with the following API calls:\n- for a Site level webhook with the [Ping Site Webh…
2 properties
2 required
nac_event_ssid
string
SSIDs the client was connecting to
webhook_client_latency_events
array
Client latency summary events included in a webhook delivery
webhook_client_sessions
object
Sample of the client-sessions webhook payload.
2 properties
2 required
webhook_site_sle_events
array
Site SLE score events included in a webhook delivery
webhook_minis_application_topic
string
Webhook topic name for Minis application test deliveries. enum: minis-application
webhook_location_client_events
array
Connected client location events included in this webhook delivery
webhook_audits
object
Sample of the audits webhook payload.
2 properties
2 required
webhook_wifi_unconn_raw
object
Sample of the wifi-unconn-raw webhook payload. This webhook topic provides raw data from packets emitted by unconnected devices. Raw data webhooks are a specia…
2 properties
2 required
webhook_rssizone_topic
string
Webhook topic name for RSSI zone event deliveries. enum: rssizone
webhook_device_events_event_ev_type
string
(optional) event advisory. enum: notice, warn
webhook_client_join
object
Sample of the client-join webhook payload.
2 properties
2 required
webhook_alarms_events
array
Alarm events included in this webhook delivery
webhook_client_info_topic
string
Webhook topic name for client information deliveries. enum: client-info
webhook_sdkclient_scan_data_event
object
SDK client connection state and background Wi-Fi scan observations
9 properties
7 required
webhook_zone_event
object
Zone enter or exit event for a Wi-Fi client, SDK client, or asset
10 properties
6 required
scan_data_item_band
string
5GHz or 2.4GHz band, associated with the BSSID scanned. enum: 2.4, 5
webhook_client_join_events
array
Client join events included in a webhook delivery
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Mist 12
Other APIs Mist publishes across the network.
Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
#Mist API
Where this information came from
This is an independent, third-party profile of Mist Mist API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.