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

A Network refers to a group or segment of users that are defined for use across the entire organization.

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

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

5 operations 2 paths 33 schemas 1 DELETE2 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 Orgs Networks 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 5

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

Orgs Networks 5

A Network refers to a group or segment of users that are defined for use across the entire organization.

GET
/api/v1/orgs/{org_id}/networks
listOrgNetworks
listOrgNetworks 3 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/networks
createOrgNetwork
createOrgNetwork 1 param body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/networks/{network_id}
deleteOrgNetwork
deleteOrgNetwork 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/networks/{network_id}
getOrgNetwork
getOrgNetwork 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/networks/{network_id}
updateOrgNetwork
updateOrgNetwork 2 params body → 200400401403404429

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are network (18 properties), network_vpn_access_config (14 properties), network_internet_access (5 properties), network_internet_access_destination_nat_property (4 properties). Each schema is shown below with its type and property counts.

network_vpn_access_destination_nat_property
object
3 properties
network_internet_access_destination_nat
object
Property key can be an External IP (i.e. "63.16.0.3"), an External IP:Port (i.e. "63.16.0.3:443"), an External Port (i.e. ":443"), an External CIDR (i.e. "63.1…
id
string
Unique ID of the object instance in the Mist Organization
network_source_nat
object
If routed==false (usually at Spoke), but some hosts needs to be reachable from Hub
1 property
network_tenant_addresses
array
network_tenant
object
1 property
network_multicast_group
object
1 property
response_http403
object
1 property
network_internal_access
object
1 property
network_internet_access
object
Whether this network has direct internet access
5 properties
network_multicast_groups
object
Group address to RP (rendezvous point) mapping. Property Key is the CIDR (example "225.1.0.3/32")
network_internet_access_static_nat_property
object
3 properties
network_vpn_access_static_nat_property
object
2 properties
response_http404
object
1 property
modified_time
number
When the object has been modified for the last time, in epoch
network_vpn_access_config
object
14 properties
network_vpn_access
object
Property key is the VPN name. Whether this network can be accessed from vpn
network_routed_for_networks
array
For a Network (usually LAN), it can be routable to other networks (e.g. OSPF)
network_vpn_access_destination_nat
object
Property key can be an External IP (i.e. "63.16.0.3"), an External IP:Port (i.e. "63.16.0.3:443"), an External Port (i.e. ":443"), an External CIDR (i.e. "63.1…
vlan_id_with_variable
response_http400
object
1 property
network_internet_access_destination_nat_property
object
4 properties
network_vpn_access_static_nat
object
Property key may be an External IP Address (i.e. "63.16.0.3"), a CIDR (i.e. "63.16.0.12/20") or a Variable (i.e. "{{myvar}}")
networks
array
response_http429
object
1 property
network_tenants
object
Property key must be the user/tenant name (i.e. "printer-1") or a Variable (i.e. "{{myvar}}")
network_vpn_access_config_other_vrfs
array
By default, the routes are only readvertised toward the same vrf on spoke. To allow it to be leaked to other vrfs
network
object
Networks are usually subnets that have cross-site significance. networksin Org Settings will got merged into networksin Site Setting. For gateways, they can be…
18 properties 1 required
network_multicast
object
Whether to enable multicast support (only PIM-sparse mode is supported)
3 properties
response_http401
object
1 property
org_id
string
created_time
number
When the object has been created, in epoch
network_internet_access_static_nat
object
Property key may be an External IP Address (i.e. "63.16.0.3"), a CIDR (i.e. "63.16.0.12/20") or a Variable (i.e. "{{myvar}}")

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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