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

An organization usually represents a customer - which has inventories, licenses.An Organization can contain multiple sites. A site usually represents a deployment at the same location (a campus, an office).

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

This API exposes 8 operations across 4 paths, and defines 28 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.

8 operations 4 paths 28 schemas 1 DELETE4 GET1 POST2 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 MSPs Orgs 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 8

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

MSPs Orgs 8

An organization usually represents a customer - which has inventories, licenses. An Organization can contain multiple sites. A site usually represents a deployment at the same loc…

GET
/api/v1/msps/{msp_id}/orgs
listMspOrgs
listMspOrgs 1 param → 200400401403404429
POST
/api/v1/msps/{msp_id}/orgs
createMspOrg
createMspOrg 1 param body → 200400401403404429
PUT
/api/v1/msps/{msp_id}/orgs
manageMspOrgs
manageMspOrgs 1 param body → 200400401403404429
GET
/api/v1/msps/{msp_id}/orgs/search
searchMspOrgs
searchMspOrgs 11 params → 200400401403404429
DELETE
/api/v1/msps/{msp_id}/orgs/{org_id}
deleteMspOrg
deleteMspOrg 2 params → 200400401403404429
GET
/api/v1/msps/{msp_id}/orgs/{org_id}
getMspOrg
getMspOrg 2 params → 200400401403404429
PUT
/api/v1/msps/{msp_id}/orgs/{org_id}
updateMspOrg
updateMspOrg 2 params body → 200400401403404429
GET
/api/v1/msps/{msp_id}/stats/orgs
listMspOrgStats
listMspOrgStats 3 params → 200400401403404429

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are response_org_search_item (24 properties), stats_org (15 properties), org (11 properties), response_org_search (6 properties). Each schema is shown below with its type and property counts.

response_org_search
object
6 properties 5 required
id
string
Unique ID of the object instance in the Mist Organization
msp_org_change_org_ids
array
List of orgid
orggroup_ids
array
strings
array
stats_org_orggroup_ids
array
response_http403
object
1 property
stats_orgs
array
msp_org_change
object
2 properties 2 required
stats_org_sle_user_minutes
object
2 properties 2 required
response_http404
object
1 property
response_org_search_results
array
response_org_search_item_usage_types
array
a list of types that enabled by usage
timestamp
number
Epoch (seconds)
org
object
11 properties 1 required
stats_org_sles
array
modified_time
number
When the object has been modified for the last time, in epoch
stats_org
object
Org statistics
15 properties 15 required
msp_org_change_operation
string
enum: assign, unassign
stats_org_sle
object
2 properties 1 required
response_http400
object
1 property
org_list
array
response_org_search_item
object
24 properties
response_http429
object
1 property
msp_id
string
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-msps-orgs-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