Juniper Mist AI Sites UI Settings API
The Site UI Settings are used to configure the site Network and Analytics reports
OpenAPI Specification
openapi: 3.1.0
info:
contact:
email: tmunzer@juniper.net
name: Thomas Munzer
description: '> Version: **2604.1.1**
>
> Date: **May 13, 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 Sites UI Settings API
version: 2604.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: []
- basicAuth: []
- basicAuth: []
csrfToken: []
tags:
- description: The Site UI Settings are used to configure the site Network and Analytics reports
name: Sites UI Settings
paths:
/api/v1/sites/{site_id}/uisettings:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: List the Site UI settings/databoard
operationId: listSiteUiSettings
responses:
'200':
$ref: '#/components/responses/UiSettingsArray'
'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: listSiteUiSettings
tags:
- Sites UI Settings
post:
description: Create a Site UI settings/databoard
operationId: createSiteUiSettings
requestBody:
content:
application/json:
examples:
Example:
value:
defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
defaultScopeType: site
defaultTimeRange:
end: 1508828400
endDate: 10/23/2017
interval: 1d
name: This Week
shortName: thisWeek
start: 1508655600
usePreset: true
description: Description of the databoard
isCustomDataboard: true
isScopeLinked: true
isTimeRangeLinked: true
name: New Databoard
purpose: databoard
tiles:
- chartBand: 2.4 ghz
chartColor: '#00B4AD'
chartDirection: tx + rx
chartRankBy: string
chartType: timeSeries
colspan: 5
column: 1
hideEmptyRows: true
metric:
apiName: client_dhcp_latency
name: New Analysis
row: 1
rowspan: 2
scopeId: e0c767834b4c
scopeType: client
timeRange:
end: 1508823743
endDate: 10/23/2017
interval: 1d
name: Past 7 Days
shortName: 7d
start: 1508223600
usePreset: true
trendType: line
vizType: averageTimeSeriesChart
schema:
$ref: '#/components/schemas/ui_settings'
description: Request Body
responses:
'200':
$ref: '#/components/responses/UiSettings'
'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: createSiteUiSettings
tags:
- Sites UI Settings
/api/v1/sites/{site_id}/uisettings/derived:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Get both site UI settings(for_site=true) and org UI settings (for_site=false)
operationId: listSiteUiSettingDerived
responses:
'200':
$ref: '#/components/responses/UiSettings'
'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: listSiteUiSettingDerived
tags:
- Sites UI Settings
/api/v1/sites/{site_id}/uisettings/{uisetting_id}:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/uisetting_id'
delete:
description: Site UI settings
operationId: deleteSiteUiSetting
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: deleteSiteUiSetting
tags:
- Sites UI Settings
get:
description: Site UI settings
operationId: getSiteUiSetting
responses:
'200':
$ref: '#/components/responses/UiSettings'
'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: getSiteUiSetting
tags:
- Sites UI Settings
post:
description: Site UI settings
operationId: updateSiteUiSetting
requestBody:
content:
application/json:
examples:
Example:
value:
defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
defaultScopeType: site
defaultTimeRange:
end: 1508828400
endDate: 10/23/2017
interval: 1d
name: This Week
shortName: thisWeek
start: 1508655600
usePreset: true
description: Description of the databoard
isCustomDataboard: true
isScopeLinked: true
isTimeRangeLinked: true
name: New Databoard
purpose: databoard
tiles:
- chartBand: 2.4 ghz
chartColor: '#00B4AD'
chartDirection: tx + rx
chartRankBy: string
chartType: timeSeries
colspan: 5
column: 1
hideEmptyRows: true
metric:
apiName: client_dhcp_latency
name: New Analysis
row: 1
rowspan: 2
scopeId: e0c767834b4c
scopeType: client
timeRange:
end: 1508823743
endDate: 10/23/2017
interval: 1d
name: Past 7 Days
shortName: 7d
start: 1508223600
usePreset: true
trendType: line
vizType: averageTimeSeriesChart
schema:
$ref: '#/components/schemas/ui_settings'
description: Request Body
responses:
'200':
$ref: '#/components/responses/UiSettings'
'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: updateSiteUiSetting
tags:
- Sites UI Settings
components:
schemas:
id:
description: Unique ID of the object instance in the Mist Organization
examples:
- 53f10664-3ce8-4c27-b382-0ef66432349f
format: uuid
readOnly: true
type: string
ui_settings_tile_sorted_columns_id:
type: string
ui_settings_tile_metric:
additionalProperties: false
properties:
apiName:
examples:
- client_dhcp_latency
type: string
type: object
response_http403:
additionalProperties: false
properties:
detail:
examples:
- You do not have permission to perform this action.
type: string
type: object
ui_settings_tiles:
items:
$ref: '#/components/schemas/ui_settings_tile'
type: array
uniqueItems: true
site_id:
examples:
- 441a1214-6928-442a-8e92-e1d34b8ec6a6
format: uuid
readOnly: true
type: string
response_http404:
additionalProperties: false
properties:
id:
type: string
type: object
ui_settings_tile_sorted_columns_ids:
items:
$ref: '#/components/schemas/ui_settings_tile_sorted_columns_id'
type: array
ui_settings_tile:
additionalProperties: false
properties:
chartBand:
examples:
- 2.4 ghz
type: string
chartColor:
examples:
- '#00B4AD'
type: string
chartDirection:
examples:
- tx + rx
type: string
chartRankBy:
type: string
chartType:
examples:
- timeSeries
type: string
colspan:
examples:
- 5
type: integer
column:
examples:
- 1
type: integer
hideEmptyRows:
type: boolean
id:
$ref: '#/components/schemas/id'
metric:
$ref: '#/components/schemas/ui_settings_tile_metric'
name:
examples:
- New Analysis
type: string
row:
examples:
- 1
type: integer
rowspan:
examples:
- 2
type: integer
scopeId:
examples:
- e0c767834b4c
type: string
scopeType:
examples:
- client
type: string
sortedColumnIds:
$ref: '#/components/schemas/ui_settings_tile_sorted_columns_ids'
timeRange:
$ref: '#/components/schemas/ui_settings_tile_time_range'
trendType:
examples:
- line
type: string
vizType:
examples:
- averageTimeSeriesChart
type: string
type: object
response_http400:
additionalProperties: false
properties:
detail:
examples:
- 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
type: string
type: object
ui_settings_list:
items:
$ref: '#/components/schemas/ui_settings'
type: array
response_http429:
additionalProperties: false
properties:
detail:
examples:
- Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
type: string
type: object
ui_settings_default_time_range:
additionalProperties: false
properties:
end:
examples:
- 1508828400
type: integer
endDate:
examples:
- 10/23/2017
type: string
interval:
examples:
- 1d
type: string
name:
examples:
- This Week
type: string
shortName:
examples:
- thisWeek
type: string
start:
examples:
- 1508655600
type: integer
usePreset:
examples:
- true
type: boolean
type: object
ui_settings:
description: UI Settings
properties:
created_time:
$ref: '#/components/schemas/created_time'
defaultScopeId:
examples:
- 67970e46-4e12-11e6-9188-0242ad112847
type: string
defaultScopeType:
examples:
- site
type: string
defaultTimeRange:
$ref: '#/components/schemas/ui_settings_default_time_range'
description:
examples:
- Description of the databoard
type: string
for_site:
examples:
- true
readOnly: true
type: boolean
id:
$ref: '#/components/schemas/id'
isCustomDataboard:
type: boolean
isScopeLinked:
type: boolean
isTimeRangeLinked:
type: boolean
modified_time:
$ref: '#/components/schemas/modified_time'
name:
examples:
- New Databoard
type: string
org_id:
$ref: '#/components/schemas/org_id'
purpose:
examples:
- databoard
type: string
site_id:
$ref: '#/components/schemas/site_id'
tiles:
$ref: '#/components/schemas/ui_settings_tiles'
required:
- description
- purpose
type: object
response_http401:
additionalProperties: false
properties:
detail:
examples:
- Authentication credentials were not provided.
type: string
type: object
org_id:
examples:
- a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
format: uuid
readOnly: true
type: string
ui_settings_tile_time_range:
additionalProperties: false
properties:
end:
examples:
- 1508823743
type: number
endDate:
examples:
- 10/23/2017
type: string
interval:
examples:
- 1d
type: string
name:
examples:
- Past 7 Days
type: string
shortName:
examples:
- 7d
type: string
start:
examples:
- 1508223600
type: integer
usePreset:
examples:
- true
type: boolean
type: object
modified_time:
description: When the object has been modified for the last time, in epoch
format: double
readOnly: true
type: number
created_time:
description: When the object has been created, in epoch
format: double
readOnly: true
type: number
responses:
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
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
UiSettingsArray:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/UiSettingsArrayExample'
schema:
$ref: '#/components/schemas/ui_settings_list'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/UiSettingsArrayExample'
schema:
$ref: '#/components/schemas/ui_settings_list'
description: List of Site UI Setting
UiSettings:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/UiSettingsExample'
schema:
$ref: '#/components/schemas/ui_settings'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/UiSettingsExample'
schema:
$ref: '#/components/schemas/ui_settings'
description: Example response
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
OK:
description: OK
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:
UiSettingsExample:
value:
created_time: 1508823803
defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
defaultScopeType: site
defaultTimeRange:
end: 1508828400
endDate: 10/23/2017
interval: 1d
name: This Week
shortName: thisWeek
start: 1508655600
usePreset: true
description: Description of the databoard
for_site: true
id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
isCustomDataboard: true
isScopeLinked: true
isTimeRangeLinked: true
modified_time: 0
name: New Databoard
org_id: cc079380-5029-4d4a-9125-858de85731ff
purpose: databoard
site_id: 67970e46-4e12-11e6-9188-0242ad112847
tiles:
- chartBand: 2.4 ghz
chartColor: '#00B4AD'
chartDirection: tx + rx
chartRankBy: string
chartType: timeSeries
colspan: 5
column: 1
hideEmptyRows: true
id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
metric:
apiName: client_dhcp_latency
name: New Analysis
row: 1
rowspan: 2
scopeId: e0c767834b4c
scopeType: client
timeRange:
end: 1508823743
endDate: 10/23/2017
interval: 1d
name: Past 7 Days
shortName: 7d
start: 1508223600
usePreset: true
trendType: line
vizType: averageTimeSeriesChart
HTTP400Example:
value:
detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
HTTP403Example:
value:
detail: You do not have permission to perform this action.
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.
UiSettingsArrayExample:
value:
- created_time: 1508823803
defaultScopeId: 67970e46-4e12-11e6-9188-0242ad112847
defaultScopeType: site
defaultTimeRange:
end: 1508828400
endDate: 10/23/2017
interval: 1d
name: This Week
shortName: thisWeek
start: 1508655600
usePreset: true
description: Description of the databoard
for_site: true
id: 3bdcc7e8-c04d-4512-b4fc-093da9057eb0
isCustomDataboard: true
isScopeLinked: true
isTimeRangeLinked: true
modified_time: 0
name: New Databoard
org_id: cc079380-5029-4d4a-9125-858de85731ff
purpose: databoard
site_id: 67970e46-4e12-11e6-9188-0242ad112847
tiles:
- chartBand: 2.4 ghz
chartColor: '#00B4AD'
chartDirection: tx + rx
chartRankBy: string
chartType: timeSeries
colspan: 5
column: 1
hideEmptyRows: true
id: 7a9ab38c-cfc3-483d-b51a-0aec571fadc0
metric:
apiName: client_dhcp_latency
name: New Analysis
row: 1
rowspan: 2
scopeId: e0c767834b4c
scopeType: client
timeRange:
end: 1508823743
endDate: 10/23/2017
interval: 1d
name: Past 7 Days
shortName: 7d
start: 1508223600
usePreset: true
trendType: line
vizType: averageTimeSeriesChart
parameters:
site_id:
in: path
name: site_id
required: true
schema:
examples:
- 000000ab-00ab-00ab-00ab-0000000000ab
format: uuid
type: string
uisetting_id:
in: path
name: uisetting_id
required: true
schema:
examples:
- 000000ab-00ab-00ab-00ab-0000000000ab
format: uuid
type: string
securitySchemes:
apiToken:
description: "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 equal or less privileges.\n\n**Format**:\n API Token value format is `Token {apitoken}`\n\n**Notes**:\n* an API token generated for a specific admin has the same privilege as the user\n* an API token will be automatically removed if not used for > 90 days\n* SSO admins cannot generate these API tokens. Refer Org level API tokens which can have privileges of a specific Org/Site for more information."
in: header
name: Authorization
type: apiKey
basicAuth:
description: While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
scheme: basic
type: http
csrfToken:
description: "This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-site_request_forgery), all the POST / PUT / DELETE APIs needs to have CSRF token in the AJAX Request header when using Login/Password authentication (with or without MFA)\n\n\nThe CSRF Token is sent back by Mist in the Cookies from the Login Response API Call:\n`cookies[csrftoken]` \n\nThe CSRF Token must be added in the HTTP Request Headers:\n```\nX-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx\n```"
in: header
name: X-CSRFToken
type: apiKey