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 WxRules API

Site WxRules are a set of rules, restrictions, and settings that can be applied to WLANs within a specific site.These policies determine how the devices and traffic are treated by the network and can be used to control access, define VLANs, and apply labels to users and resources.Site WxRules are created and managed at the site level and are applied after the site-level WxRules.

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

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

6 operations 3 paths 19 schemas 1 DELETE3 GET1 POST1 PUT

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 WxRules 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 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Sites WxRules 6

Site WxRules are a set of rules, restrictions, and settings that can be applied to WLANs within a specific site. These policies determine how the devices and traffic are treated b…

GET
/api/v1/sites/{site_id}/wxrules
listSiteWxRules
listSiteWxRules 3 params → 200400401403404429
POST
/api/v1/sites/{site_id}/wxrules
createSiteWxRule
createSiteWxRule 1 param body → 200400401403404429
GET
/api/v1/sites/{site_id}/wxrules/derived
ListSiteWxRulesDerived
ListSiteWxRulesDerived 1 param → 200400401403404429
DELETE
/api/v1/sites/{site_id}/wxrules/{wxrule_id}
deleteSiteWxRule
deleteSiteWxRule 2 params → 200400401403404429
GET
/api/v1/sites/{site_id}/wxrules/{wxrule_id}
getSiteWxRule
getSiteWxRule 2 params → 200400401403404429
PUT
/api/v1/sites/{site_id}/wxrules/{wxrule_id}
updateSiteWxRule
updateSiteWxRule 2 params body → 200400401403404429

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are wxlan_rule (16 properties), response_http400 (1 property), response_http401 (1 property), response_http404 (1 property). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
wxlan_rule_dst_allow_wxtags
array
List of WxTag UUID to indicate these tags are allowed access
response_http403
object
1 property
site_id
string
response_http404
object
1 property
modified_time
number
When the object has been modified for the last time, in epoch
response_http400
object
1 property
wxlan_rule
object
WXlan
16 properties 2 required
wxlan_rule_blocked_apps
array
Blocked apps (always blocking, ignoring action), the key of Get Application List
wxlan_rule_action
string
type of action, allow / block. enum: allow, block
wxlan_rule_dst_deny_wxtags
array
List of WxTag UUID to indicate these tags are blocked access
wxlan_rule_apply_tags
array
response_http429
object
1 property
wxlan_rule_src_wxtags
array
List of WxTag UUID to determine if this rule would match
wxlan_rule_dst_wxtags
array
List of WxTag UUID
wxlan_rules
array
response_http401
object
1 property
org_id
string
created_time
number
When the object has been created, in epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-sites-wxrules-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