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 Orgs UI Settings API

The Org UI Settings are used to configure the MArvis dashboards

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

This API exposes 5 operations across 2 paths, and defines 16 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.

5 operations 2 paths 16 schemas 1 DELETE2 GET2 POST

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 Orgs UI Settings 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 5

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

Orgs UI Settings 5

The Org UI Settings are used to configure the MArvis dashboards

GET
/api/v1/orgs/{org_id}/uisettings
listOrgUiSettings
listOrgUiSettings 1 param → 200400401403404429
POST
/api/v1/orgs/{org_id}/uisettings
createOrgUiSettings
createOrgUiSettings 1 param body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/uisettings/{uisetting_id}
deleteOrgUiSetting
deleteOrgUiSetting 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/uisettings/{uisetting_id}
getOrgUiSetting
getOrgUiSetting 2 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/uisettings/{uisetting_id}
updateOrgUiSetting
updateOrgUiSetting 2 params body → 200400401403404429

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are org_ui_settings (11 properties), org_ui_settings_tile (6 properties), org_ui_settings_tile_position (4 properties), response_http400 (1 property). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
response_http403
object
1 property
org_ui_settings
object
11 properties
site_id
string
response_http404
object
1 property
org_ui_settings_tile
object
6 properties
response_http400
object
1 property
org_ui_settings_tile_position
object
4 properties
response_http429
object
1 property
org_ui_settings_tiles
array
List of tiles in the databoard
org_ui_settings_list
array
org_ui_settings_purpose
string
enum: marvisdashboard
response_http401
object
1 property
org_id
string
modified_time
number
When the object has been modified for the last time, in epoch
created_time
number
When the object has been created, in epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-orgs-ui-settings-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