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 Orgs Devices API

Devices are any Network device managed or monitored by Juniper Mist. It can be * Wireless Access Points * Juniper Switch (EX, QFX) * Juniper WAN Gateway (SRX, SSR) * Mist Edges * Other or 3rd party devices, like Cradlepoint Devices

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

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

10 operations 10 paths 57 schemas 10 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 Orgs Devices 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 10

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

Orgs Devices 10

Devices are any Network device managed or monitored by Juniper Mist. It can be Wireless Access Points Juniper Switch (EX, QFX) Juniper WAN Gateway (SRX, SSR) Mist Edges Other or 3…

GET
/api/v1/orgs/{org_id}/devices
listOrgDevices
listOrgDevices 1 param → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/count
countOrgDevices
countOrgDevices 20 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/events/count
countOrgDeviceEvents
countOrgDeviceEvents 13 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/events/search
searchOrgDeviceEvents
searchOrgDeviceEvents 15 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/last_config/count
countOrgDeviceLastConfigs
countOrgDeviceLastConfigs 7 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/last_config/search
searchOrgDeviceLastConfigs
searchOrgDeviceLastConfigs 12 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/radio_macs
listOrgApsMacs
listOrgApsMacs 3 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/search
searchOrgDevices
searchOrgDevices 43 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/summary
listOrgDevicesSummary
listOrgDevicesSummary 1 param → 200400401403404429
GET
/api/v1/orgs/{org_id}/ocdevices/outbound_ssh_cmd
getOrgJuniperDevicesCommand
getOrgJuniperDevicesCommand 2 params → 200400401403404429

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are ap_search (36 properties), device_event (30 properties), gateway_search (27 properties), switch_search (24 properties). Each schema is shown below with its type and property counts.

response_device_search_results
array
response_config_history_search_item_wlans
array
response_config_history_search_item_radio
object
2 properties 2 required
strings
array
response_device_events_search
object
6 properties 5 required
count_org_devices_mxtunnel_status
string
enum: down, up
timestamp
number
Epoch (seconds)
response_config_history_search_item_radios
array
search_org_devices_mxtunnel_status
string
enum: down, up
device_event
object
30 properties 3 required
device_type
string
enum: ap, gateway, switch
response_device_search
object
6 properties 5 required
response_http401
object
1 property
ap_radio_mac_radio_macs
array
response_count
object
6 properties 6 required
response_org_devices
object
1 property 1 required
device_type_switch
string
Device Type. enum: switch
switch_search
object
24 properties 1 required
response_config_history_search_results
array
org_device
object
2 properties 2 required
device_type_with_all
string
ap, switch, gateway, router, all, default is ap. Supports comma-separated values for multiple types (e.g., type=switch,gateway)
ap_search_wlans
array
response_device_config_cmd
object
1 property 1 required
ap_radio_macs
array
response_device_search_results_items
device_search_radius_stat
object
4 properties
org_devices
array
ha_cluster_node_enum
string
only for HA. enum: node0, node1
device_search_radius_stats
object
Property key is the RADIUS server IP Address
org_devices_events_count_distinct
string
enum: ap, apfw, model, orgid, siteid, text, timestamp, type
org_devices_count_distinct
string
enum: hostname, ip, lldpmgmtaddr, lldpportid, lldpsystemdesc, lldpsystemname, mac, model, mxedgeid, mxtunnelstatus, siteid, version
response_config_history_search
object
6 properties 5 required
ap_search_hostnames
array
List of hostnames detected for the AP
ap_radio_mac
object
2 properties 2 required
count_result
object
1 property 1 required
response_org_devices_summary
object
7 properties
response_config_history_search_item
object
11 properties 5 required
device_events
array
device_search_radius_filter_status
string
Status of the device search radius filter. enum: up, down, unreachable
gateway_search
object
27 properties 1 required
response_http429
object
1 property
org_id
string
id
string
Unique ID of the object instance in the Mist Organization
response_http403
object
1 property
count_results
array
site_id
string
ap_search
object
36 properties 4 required
response_http404
object
1 property
webhook_device_events_event_ev_type
string
(optional) event advisory. enum: notice, warn
ap_search_wlan
object
2 properties
response_http400
object
1 property
device_type_default_ap
string
enum: ap, gateway, switch
ap_search_inactive_wired_vlans
array
org_devices_last_configs_count_distinct
string
enum: mac, name, siteid, version
last_config_device_type
string
enum: ap, gateway, mxedge, switch
response_config_history_search_item_wlan
object
5 properties 3 required
device_type_gateway
string
Device Type. enum: gateway

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-orgs-devices-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