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 Stats - Ports API

API Calls to retrieve statistics about the Wired Ports at the Site level

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

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

2 operations 2 paths 27 schemas 2 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 Stats - Ports 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 2

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

Sites Stats - Ports 2

API Calls to retrieve statistics about the Wired Ports at the Site level

GET
/api/v1/sites/{site_id}/stats/ports/count
countSiteSwOrGwPorts
countSiteSwOrGwPorts 31 params → 200400401403404429
GET
/api/v1/sites/{site_id}/stats/ports/search
searchSiteSwOrGwPorts
searchSiteSwOrGwPorts 25 params → 200400401403404429

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are stats_switch_port (50 properties), response_switch_port_search (6 properties), response_count (6 properties), count_result (1 property). Each schema is shown below with its type and property counts.

response_switch_port_search
object
6 properties 3 required
response_count
object
6 properties 6 required
port_stp_role
string
enum: alternate, backup, designated, disabled, root, root-prevented
response_http403
object
1 property
port_stp_state
string
enum: blocking, disabled, forwarding, learning, listening
count_results
array
response_switch_port_search_results
array
count_result
object
1 property 1 required
tx_pkts
integernull
Amount of packets sent since connection
site_ports_count_distinct
string
enum: fullduplex, mac, neighbormac, neighborportdesc, neighborsystemname, poedisabled, poemode, poeon, portid, portmac, speed, up
tx_bps
integernull
Rate of transmitting traffic, bits/seconds, last known
site_id
string
response_http404
object
1 property
stats_switch_port_poe_mode
string
enum: 802.3af, 802.3at, 802.3bt
rx_bps
integernull
Rate of receiving traffic, bits/seconds, last known
response_http400
object
1 property
tx_bytes
integernull
Amount of traffic sent since connection
response_http429
object
1 property
stats_switch_port
object
Switch port statistics
50 properties 4 required
poe_priority
string
PoE priority. enum: low, high
stats_switch_port_type
string
device type. enum: ap, ble, gateway, mxedge, nac, switch
port_auth_state
string
enum: authenticated, authenticating, held, init
response_http401
object
1 property
org_id
string
rx_bytes
integernull
Amount of traffic received since connection
rx_pkts
integernull
Amount of packets received since connection
search_org_sw_or_gw_ports_type
string
enum: switch, gateway, all

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-sites-stats-ports-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