Mist MSPs API
MSP (Managed Service Provider) contains multiple Organizations.
OpenAPI Specification
openapi: 3.1.0
info:
contact:
email: tmunzer@juniper.net
name: Thomas Munzer
description: '> Version: **2606.1.1**
>
> Date: **July 10, 2026**
<div class="notification"> NOTE:<br>Some important API changes will be introduced. Please make sure to read the <a href="https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/important-api-changes">announcements</a> </div>
---
## Additional Documentation
* [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html)
* [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location-services/topics/concept/mist-how-get-mist-sdk.html)
* [Mist Product Updates](https://www.juniper.net/documentation/us/en/software/mist/product-updates/)
## Helpful Resources
* [API Sandbox and Exercises](https://api-class.mist.com/)
* [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace)
* [Python Script Examples](https://github.com/tmunzer/mist_library)
* [API Demo Apps](https://apps.mist-lab.fr/)
* [Juniper Blog](https://blogs.juniper.net/)
## Mist Web Browser Extension:
* Google Chrome, Microsoft Edge and other Chromium-based browser: [Chrome Web Store](https://chromewebstore.google.com/detail/mist-extension/ejhpdcljeamillfhdihkkmoakanpbplh)
* Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mist-extension/)
---'
license:
name: MIT
url: https://raw.githubusercontent.com/tmunzer/Mist-OAS3.0/main/LICENSE
title: Mist Admins MSPs API
version: 2606.1.1
x-logo:
altText: Juniper-MistAI
backgroundColor: '#FFFFFF'
url: https://www.mist.com/wp-content/uploads/logo.png
servers:
- description: Mist Global 01
url: https://api.mist.com
- description: Mist Global 02
url: https://api.gc1.mist.com
- description: Mist Global 03
url: https://api.ac2.mist.com
- description: Mist Global 04
url: https://api.gc2.mist.com
- description: Mist Global 05
url: https://api.gc4.mist.com
- description: Mist EMEA 01
url: https://api.eu.mist.com
- description: Mist EMEA 02
url: https://api.gc3.mist.com
- description: Mist EMEA 03
url: https://api.ac6.mist.com
- description: Mist EMEA 04
url: https://api.gc6.mist.com
- description: Mist APAC 01
url: https://api.ac5.mist.com
- description: Mist APAC 02
url: https://api.gc5.mist.com
- description: Mist APAC 03
url: https://api.gc7.mist.com
security:
- apiToken: []
- csrfToken: []
tags:
- description: MSP (Managed Service Provider) contains multiple Organizations.
name: MSPs
paths:
/api/v1/msps:
post:
description: Create a managed service provider account that can own organizations, organization groups, admins, licenses, and MSP-level settings.
operationId: createMsp
requestBody:
content:
application/json:
examples:
Example:
value:
name: MSP
schema:
$ref: '#/components/schemas/msp'
description: Request Body
responses:
'200':
$ref: '#/components/responses/Msp'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: createMsp
tags:
- MSPs
/api/v1/msps/{msp_id}:
parameters:
- $ref: '#/components/parameters/msp_id'
delete:
description: Delete the MSP account and its MSP-level organization groups and privileges. This does not delete any organizations or administrator accounts.
operationId: deleteMsp
responses:
'200':
$ref: '#/components/responses/OK'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: deleteMsp
tags:
- MSPs
get:
description: Return MSP account details, including the display name, service tier, support-access setting, logo URL, custom URL, and timestamps.
operationId: getMspDetails
responses:
'200':
$ref: '#/components/responses/Msp'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: getMspDetails
tags:
- MSPs
put:
description: Update editable MSP account settings such as the display name, support-access setting, logo URL, or custom URL.
operationId: updateMsp
requestBody:
content:
application/json:
examples:
Example:
value:
name: MSP
schema:
$ref: '#/components/schemas/msp'
description: Request Body
responses:
'200':
$ref: '#/components/responses/Msp'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: updateMsp
tags:
- MSPs
/api/v1/msps/{msp_id}/search:
parameters:
- $ref: '#/components/parameters/msp_id'
get:
description: Search MSP resources by query string. Currently `type=orgs` returns matching organizations in this MSP.
operationId: searchMspOrgGroup
parameters:
- description: 'MSP search result type to return. enum: `orgs`'
example: orgs
in: query
name: type
required: true
schema:
$ref: '#/components/schemas/msp_search_type'
- description: Filter results by search string
in: query
name: q
required: true
schema:
examples:
- live
type: string
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/sort'
responses:
'200':
$ref: '#/components/responses/Search'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: searchMspOrgGroup
tags:
- MSPs
components:
responses:
OK:
description: OK
HTTP400:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP400Example'
schema:
$ref: '#/components/schemas/response_http400'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP400Example'
schema:
$ref: '#/components/schemas/response_http400'
description: Bad Syntax
HTTP403:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP403Example'
schema:
$ref: '#/components/schemas/response_http403'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP403Example'
schema:
$ref: '#/components/schemas/response_http403'
description: Permission Denied
Msp:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/MspExample'
schema:
$ref: '#/components/schemas/msp'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/MspExample'
schema:
$ref: '#/components/schemas/msp'
description: OK
Search:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/SearchExample'
schema:
$ref: '#/components/schemas/response_search'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/SearchExample'
schema:
$ref: '#/components/schemas/response_search'
description: OK
HTTP404:
content:
application/json:
schema:
$ref: '#/components/schemas/response_http404'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/response_http404'
description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
HTTP429:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP429Example'
schema:
$ref: '#/components/schemas/response_http429'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP429Example'
schema:
$ref: '#/components/schemas/response_http429'
description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
HTTP401:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP401Example'
schema:
$ref: '#/components/schemas/response_http401'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP401Example'
schema:
$ref: '#/components/schemas/response_http401'
description: Unauthorized
parameters:
msp_id:
in: path
name: msp_id
required: true
schema:
examples:
- 000000ab-00ab-00ab-00ab-0000000000ab
format: uuid
type: string
start:
description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
in: query
name: start
schema:
type: string
sort:
description: On which field the list should be sorted, -prefix represents DESC order
in: query
name: sort
schema:
default: timestamp
examples:
- -site_id
type: string
duration:
description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
in: query
name: duration
schema:
default: 1d
examples:
- 10m
type: string
limit:
description: Maximum number of results to return per page
in: query
name: limit
schema:
default: 100
minimum: 0
type: integer
end:
description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
in: query
name: end
schema:
type: string
schemas:
response_search_item:
additionalProperties: false
description: MSP search result entry
properties:
id:
$ref: '#/components/schemas/id'
description: Unique identifier for the matching MSP search result
text:
description: Display text for the MSP search result
type: string
type:
description: Category of MSP search result, such as `orgs`
type: string
required:
- id
- text
- type
type: object
id:
description: Unique ID of the object instance in the Mist Organization
examples:
- 53f10664-3ce8-4c27-b382-0ef66432349f
format: uuid
readOnly: true
type: string
response_http429:
additionalProperties: false
description: Standard HTTP 429 rate limit error response
properties:
detail:
description: Human-readable explanation of the rate limit error
examples:
- Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
type: string
type: object
response_http401:
additionalProperties: false
description: Standard HTTP 401 authentication error response
properties:
detail:
description: Human-readable explanation of the authentication error
examples:
- Authentication credentials were not provided.
type: string
type: object
msp_search_type:
description: 'Search result type returned by MSP organization search. enum: `orgs`'
enum:
- orgs
type: string
created_time:
description: When the object has been created, in epoch
format: double
readOnly: true
type: number
response_http403:
additionalProperties: false
description: Standard HTTP 403 permission error response
properties:
detail:
description: Human-readable explanation of the permission error
examples:
- You do not have permission to perform this action.
type: string
type: object
msp_tier:
default: base
description: 'Service tier for the MSP account. enum: `advanced`, `base`'
enum:
- advanced
- base
type: string
response_search_results:
description: MSP search result entries returned by search
items:
$ref: '#/components/schemas/response_search_item'
type: array
uniqueItems: true
response_http400:
additionalProperties: false
description: Standard HTTP 400 bad request error response
properties:
detail:
description: Human-readable explanation of the bad request error
examples:
- 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
type: string
type: object
response_search:
additionalProperties: false
description: Paginated response for MSP organization search results
properties:
limit:
description: Maximum number of MSP search results returned in this page
type: integer
next:
description: URL for retrieving the next page of MSP search results
type: string
page:
description: Current page number returned for the MSP search results
type: integer
results:
$ref: '#/components/schemas/response_search_results'
description: MSP search result entries matching the query
total:
description: Number of MSP search results matching the query across all pages
type: integer
required:
- limit
- page
- results
- total
type: object
msp:
description: Managed service provider account
properties:
allow_mist:
description: Whether Mist support access is allowed for this MSP account
type: boolean
created_time:
$ref: '#/components/schemas/created_time'
description: Timestamp when the MSP account was created
id:
$ref: '#/components/schemas/id'
description: Unique identifier of the MSP account
logo_url:
description: For advanced tier (uMSPs) only
type: string
modified_time:
$ref: '#/components/schemas/modified_time'
description: Timestamp when the MSP account was last modified
name:
description: Display name of the MSP account
type: string
tier:
$ref: '#/components/schemas/msp_tier'
description: Service tier for the MSP account
url:
description: For advanced tier (uMSPs) only
type: string
type: object
modified_time:
description: When the object has been modified for the last time, in epoch
format: double
readOnly: true
type: number
response_http404:
additionalProperties: false
description: Standard HTTP 404 not found error response
properties:
id:
description: Missing resource identifier, when the API includes one
type: string
type: object
examples:
SearchExample:
value:
limit: 0
page: 0
results:
- id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
text: string
type: string
total: 0
HTTP403Example:
value:
detail: You do not have permission to perform this action.
HTTP400Example:
value:
detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
MspExample:
value:
created_time: 0
id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
modified_time: 0
name: string
HTTP429Example:
value:
detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
HTTP401Example:
value:
detail: Authentication credentials were not provided.
securitySchemes:
apiToken:
description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed."
in: header
name: Authorization
type: apiKey
csrfToken:
description: 'Session-based authentication for browser or login/password flows. After a successful [Login](/#operations/login) request, Mist returns a `csrftoken` cookie. Send that value in the `X-CSRFToken` header on later API requests that use the login session.
**Format**:
```
X-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx
```
For automation, API Token authentication is preferred.'
in: header
name: X-CSRFToken
type: apiKey