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

A Service represents an a traffic destination or an application that network users connect to. They are associated with users and networks and are used in application policies to permit or deny access.Services are defined at the [Org level](/#operations/createOrgService).The Site level endpoints can be used to get the site services statistics or the derived services, meaning the merge between the site level configuration and the org level configuration.

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

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

3 operations 3 paths 35 schemas 3 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 Services 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 3

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

Sites Services 3

A Service represents an a traffic destination or an application that network users connect to. They are associated with users and networks and are used in application policies to…

GET
/api/v1/sites/{site_id}/services/derived
listSiteServicesDerived
listSiteServicesDerived 2 params → 200400401403404429
GET
/api/v1/sites/{site_id}/services/events/count
countSiteServicePathEvents
countSiteServicePathEvents 16 params → 200400401403404429
GET
/api/v1/sites/{site_id}/services/events/search
searchSiteServicePathEvents
searchSiteServicePathEvents 19 params → 200400401403404429

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are service (27 properties), service_path_event (12 properties), response_count (6 properties), response_events_path_search (6 properties). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
response_count
object
6 properties 6 required
response_http403
object
1 property
service_apps
array
When type==apps, list of applications are available through: [List Applications](/operations/listApplications) [List Gateway Applications](/operations/listGate…
response_events_path_search
object
6 properties
count_results
array
service_failover_policy
string
enum: nonrevertible, none, revertible
service_traffic_class
string
when traffictype==custom. enum: besteffort, high, low, medium
response_events_path_search_results
array
count_result
object
1 property 1 required
services
array
service_dscp
For SSR only, when traffictype==custom. 0-63 or variable
service_urls
array
When type==urls, no need for spec as URL can encode the ports being used
service_max_loss
For SSR only, when traffictype==custom, for uplink selection. 0-100 or variable
site_id
string
response_http404
object
1 property
service_type
string
enum: appcategories, apps, custom, urls
timestamp
number
Epoch (seconds)
service_addresses
array
If type==custom, IPv4 and/or IPv6 subnets (e.g. 10.0.0.0/8, fd28::/128)
modified_time
number
When the object has been modified for the last time, in epoch
service_app_subcategories
array
When type==appcategories, list of application categories are available through [List App Sub Category Definitions](/operations/listAppSubCategoryDefinitions)
response_http400
object
1 property
service_max_jitter
For SSR only, when traffictype==custom, for uplink selection. 0-2147483647 or variable
service_hostnames
array
If type==custom, web filtering
service_app_categories
array
When type==appcategories, list of application categories are available through [List App Category Definitions](/operations/listAppCategoryDefinitions)
response_http429
object
1 property
service
object
Applications used for the Gateway configurations
27 properties
service_spec
object
2 properties
service_path_event
object
12 properties
site_service_events_count_distinct
string
enum: mac, model, policy, portid, siteid, type, vpnname, vpnpath
response_http401
object
1 property
org_id
string
service_max_latency
For SSR only, when traffictype==custom, for uplink selection. 0-2147483647 or variable
created_time
number
When the object has been created, in epoch
service_specs
array
When type==custom, optional, if it doesn't exist, http and https is assumed

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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