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 Orgs Services 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: 'A Service refers to the applications that network users will connect to. These applications represent traffic destinations and are essential for defining network policies and security configurations.
Applications can be defined manually in the Juniper Mist cloud portal. They can be categorized as: * Custom Applications: Defined using IP prefixes, protocols, and port ranges. * Predefined Applications: Selected from a list of common applications (e.g., Social Media, Microsoft Teams). * URL Categories: Used to define applications based on specific URLs.'
name: Orgs Services
paths:
/api/v1/orgs/{org_id}/services:
parameters:
- $ref: '#/components/parameters/org_id'
get:
description: List organization service definitions. Services describe applications, application categories, URLs, hostnames, subnets, or custom protocol and port match criteria used by gateway and SSR policies.
operationId: listOrgServices
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/page'
responses:
'200':
$ref: '#/components/responses/ServicesArray'
'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: listOrgServices
tags:
- Orgs Services
post:
description: 'Create an organization service definition with the match criteria
used by gateway and SSR policies, such as applications, URLs, hostnames,
subnets, or custom protocol and port rules.
Services can be user in the service policies to allow or deny traffic matching the service or to apply specific inspection settings or steering rules.'
operationId: createOrgService
requestBody:
content:
application/json:
examples:
Example:
value:
addresses:
- 0.0.0.0/0
app_key: string
name: string
network_id: d6797cf4-42b9-4cad-8591-9dd91c3f0fc3
specs:
- port_range: 8080,8443
protocol: any
subnet: string
type: custom
schema:
$ref: '#/components/schemas/service'
responses:
'200':
$ref: '#/components/responses/Service'
'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: createOrgService
tags:
- Orgs Services
/api/v1/orgs/{org_id}/services/{service_id}:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/service_id'
delete:
description: Remove an organization service definition from the available service catalog.
operationId: deleteOrgService
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: deleteOrgService
tags:
- Orgs Services
get:
description: Return an organization service definition, including its matching mode, match values, traffic classification, and optional SSR path-selection thresholds.
operationId: getOrgService
responses:
'200':
$ref: '#/components/responses/Service'
'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: getOrgService
tags:
- Orgs Services
put:
description: Update an organization service definition, including its matching mode, match values, traffic classification, or optional SSR path-selection thresholds.
operationId: updateOrgService
requestBody:
content:
application/json:
examples:
Example:
value:
addresses:
- string
app_categories:
- string
apps:
- string
dscp: 0
failover_policy: revertible
hostnames:
- string
max_jitter: 0
max_latency: 0
max_loss: 0
name: string
sle_enabled: false
specs:
- port_range: '0'
protocol: any
traffic_class: best_effort
traffic_type: data_best_effort
type: custom
vpn_name: addresses
schema:
$ref: '#/components/schemas/service'
responses:
'200':
$ref: '#/components/responses/Service'
'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: updateOrgService
tags:
- Orgs Services
components:
schemas:
service_apps:
description: "When `type`==`apps`, list of applications are available through:\n * [List Applications](/#operations/listApplications)\n * [List Gateway Applications](/#operations/listGatewayApplications)\n * /insight/top_app_by-bytes?wired=true"
examples:
- - office365
- okta
items:
type: string
type: array
service_dscp:
description: For SSR only, when `traffic_type`==`custom`. 0-63 or variable
oneOf:
- type: string
- maximum: 63
minimum: 0
type: integer
services:
description: Service definitions returned by list operations
items:
$ref: '#/components/schemas/service'
type: array
service_specs:
description: When `type`==`custom`, optional, if it doesn't exist, http and https is assumed
items:
$ref: '#/components/schemas/service_spec'
type: array
service_traffic_class:
default: best_effort
description: 'when `traffic_type`==`custom`. enum: `best_effort`, `high`, `low`, `medium`'
enum:
- best_effort
- high
- low
- medium
type: string
id:
description: Unique ID of the object instance in the Mist Organization
examples:
- 53f10664-3ce8-4c27-b382-0ef66432349f
format: uuid
readOnly: true
type: string
org_id:
description: Unique identifier of a Mist organization
examples:
- a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
format: uuid
readOnly: true
type: string
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
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
created_time:
description: When the object has been created, in epoch
format: double
readOnly: true
type: number
service_max_loss:
description: For SSR only, when `traffic_type`==`custom`, for uplink selection. 0-100 or variable
oneOf:
- type: string
- maximum: 100
minimum: 0
type: integer
service_failover_policy:
default: revertible
description: 'enum: `non_revertible`, `none`, `revertible`'
enum:
- non_revertible
- none
- revertible
type: string
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
service_app_categories:
description: When `type`==`app_categories`, list of application categories are available through [List App Category Definitions](/#operations/listAppCategoryDefinitions)
examples:
- - Sports
items:
type: string
type: array
service_max_jitter:
description: For SSR only, when `traffic_type`==`custom`, for uplink selection. 0-2147483647 or variable
oneOf:
- type: string
- maximum: 2147483647
minimum: 0
type: integer
service_urls:
description: When `type`==`urls`, no need for spec as URL can encode the ports being used
items:
type: string
type: array
service_app_subcategories:
description: When `type`==`app_categories`, list of application categories are available through [List App Sub Category Definitions](/#operations/listAppSubCategoryDefinitions)
examples:
- - Shopping
items:
type: string
type: array
service:
description: Traffic service definition for applications or destinations used by gateway and SSR policies
properties:
addresses:
$ref: '#/components/schemas/service_addresses'
description: Custom IPv4 or IPv6 subnets matched by this service when `type`==`custom`
app_categories:
$ref: '#/components/schemas/service_app_categories'
description: Categories of applications matched by this service when `type`==`app_categories`
app_subcategories:
$ref: '#/components/schemas/service_app_subcategories'
description: Application subcategories matched by this service when `type`==`app_categories`
apps:
$ref: '#/components/schemas/service_apps'
description: Application identifiers matched by this service when `type`==`apps`
client_limit_down:
default: 0
description: 0 means unlimited, value from 0 to 107374182
examples:
- 300000
maximum: 107374182
minimum: 0
type: integer
client_limit_up:
default: 0
description: 0 means unlimited, value from 0 to 107374182
examples:
- 300000
maximum: 107374182
minimum: 0
type: integer
created_time:
$ref: '#/components/schemas/created_time'
description: Timestamp when the service definition was created, in epoch seconds
description:
description: Free-form description of the service definition
type: string
dscp:
$ref: '#/components/schemas/service_dscp'
description: QoS DSCP value used for custom SSR traffic classification
failover_policy:
$ref: '#/components/schemas/service_failover_policy'
description: Failover behavior for traffic matched by this service
hostnames:
$ref: '#/components/schemas/service_hostnames'
description: Domain hostnames matched by this custom service for web filtering
id:
$ref: '#/components/schemas/id'
description: Unique value identifying the service definition
max_jitter:
$ref: '#/components/schemas/service_max_jitter'
description: Maximum jitter threshold used for SSR uplink selection when `traffic_type`==`custom`
max_latency:
$ref: '#/components/schemas/service_max_latency'
description: Maximum latency threshold used for SSR uplink selection when `traffic_type`==`custom`
max_loss:
$ref: '#/components/schemas/service_max_loss'
description: Maximum packet loss threshold used for SSR uplink selection when `traffic_type`==`custom`
modified_time:
$ref: '#/components/schemas/modified_time'
description: Timestamp when the service definition was last modified, in epoch seconds
name:
description: Display name of the service definition
type: string
org_id:
$ref: '#/components/schemas/org_id'
description: Organization identifier associated with the service definition
service_limit_down:
default: 0
description: 0 means unlimited, value from 0 to 107374182
examples:
- 300000
maximum: 107374182
minimum: 0
type: integer
service_limit_up:
default: 0
description: 0 means unlimited, value from 0 to 107374182
examples:
- 300000
maximum: 107374182
minimum: 0
type: integer
sle_enabled:
default: false
description: Whether to enable measure SLE
type: boolean
specs:
$ref: '#/components/schemas/service_specs'
description: Protocol and port match rules used when `type`==`custom`
ssr_relaxed_tcp_state_enforcement:
default: false
description: Whether SSR relaxes TCP state enforcement for this service
type: boolean
traffic_class:
$ref: '#/components/schemas/service_traffic_class'
description: Traffic class applied when `traffic_type`==`custom`
traffic_type:
default: data_best_effort
description: values from [List Traffic Types](/#operations/listTrafficTypes)
type: string
type:
$ref: '#/components/schemas/service_type'
description: Matching mode that determines which app, URL, or custom fields are used
urls:
$ref: '#/components/schemas/service_urls'
description: URL patterns matched by this service when `type`==`urls`
type: object
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
service_max_latency:
description: For SSR only, when `traffic_type`==`custom`, for uplink selection. 0-2147483647 or variable
oneOf:
- type: string
- maximum: 2147483647
minimum: 0
type: integer
service_addresses:
description: If `type`==`custom`, IPv4 and/or IPv6 subnets (e.g. 10.0.0.0/8, fd28::/128)
examples:
- - 10.0.0.0/8
- 172.21.0.0/16
- 2001:db8:abcd:12::/64
- fd28::/128
items:
type: string
type: array
service_spec:
additionalProperties: false
description: Protocol and port match rule for a custom service
properties:
port_range:
description: Port number, port range, or variable
examples:
- 8080,8443
type: string
protocol:
default: any
description: '`https`/ `tcp` / `udp` / `icmp` / `gre` / `any` / `:protocol_number`, `protocol_number` is between 1-254'
examples:
- tcp
type: string
type: object
service_type:
default: custom
description: 'enum: `app_categories`, `apps`, `custom`, `urls`'
enum:
- app_categories
- apps
- custom
- urls
type: string
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
service_hostnames:
description: If `type`==`custom`, web filtering
items:
examples:
- example.com
type: string
type: array
parameters:
org_id:
in: path
name: org_id
required: true
schema:
examples:
- 000000ab-00ab-00ab-00ab-0000000000ab
format: uuid
type: string
service_id:
in: path
name: service_id
required: true
schema:
examples:
- 000000ab-00ab-00ab-00ab-0000000000ab
format: uuid
type: string
limit:
description: Maximum number of results to return per page
in: query
name: limit
schema:
default: 100
minimum: 0
type: integer
page:
description: Select the page number to return when using page-based pagination; starts at `1`
in: query
name: page
schema:
default: 1
minimum: 1
type: integer
responses:
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
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
ServicesArray:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/ServicesArrayExample'
schema:
$ref: '#/components/schemas/services'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/ServicesArrayExample'
schema:
$ref: '#/components/schemas/services'
description: OK
Service:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/ServiceExample'
schema:
$ref: '#/components/schemas/service'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/ServiceExample'
schema:
$ref: '#/components/schemas/service'
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
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
examples:
HTTP403Example:
value:
detail: You do not have permission to perform this action.
ServiceExample:
value:
addresses:
- string
app_categories:
- string
apps:
- string
created_time: 0
dscp: 0
failover_policy: revertible
hostnames:
- string
id: 497f6eca-6276-5004-bfeb-53cbbbba6f16
max_jitter: 0
max_latency: 0
max_loss: 0
modified_time: 0
name: string
org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
sle_enabled: false
specs:
- port_range: '0'
protocol: any
traffic_class: best_effort
traffic_type: data_best_effort
type: custom
vpn_name: addresses
HTTP400Example:
value:
detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
HTTP429Example:
value:
detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
ServicesArrayExample:
value:
- addresses:
- string
apps:
- string
dscp: 8
hostnames:
- string
max_jitter: 0
max_latency: 0
max_loss: 0
name: string
specs:
- port_range: '0'
protocol: any
traffic_class: best_effort
traffic_type: default
type: custom
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