Mist API

https://www.juniper.net/documentation/us/en/software/mist/
Admin
Mist API is a comprehensive REST API for managing and automating Juniper Mist AI-driven wireless...
Tokens:9,706,413
Snippets:84,002
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Org Setting Installer - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/org-setting-installer

Provides guidance on how to get started with the Org Setting Installer for the Mist API. This typically involves initial setup and configuration steps required before utilizing the API for organizational settings.

```HTTP
POST /api/v1/orgs/{org_id}/settings/installer

```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/org-setting-switch-mgmt

Provides guidance on how to get started with the Mist API, including initial setup and common workflows.

```HTTP
GET /api/v1/getting_started
```

--------------------------------

### Mist API - Getting Started Guide

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-wireless-client

This guide provides instructions on how to get started with the Mist API, including initial setup, authentication, and making your first API requests. It's designed for users new to the Mist API.

```API
Getting Started
```

--------------------------------

### Mist API - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/sdkstats-wireless-client-vbeacon

This guide explains how to get started with the Mist API, outlining the initial steps and prerequisites for accessing and utilizing the API functionalities. It is essential for new users to understand the setup process.

--------------------------------

### Juniper Mist Management Guide - Get Started

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-management/topics/concept/security-options

This section provides initial guidance for using the Juniper Mist Management Guide, covering the configuration hierarchy, admin menu overview, initial setup tasks, and account creation.

```text
Get Started
Mist Configuration Hierarchy
Admin Menu Overview
Initial Configuration Tasks
Create Your Organization and Account
Account Settings and Preferences
Account Settings
```

--------------------------------

### Mist API Getting Started Guide

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/map-micello

This guide explains how to get started with the Mist API, covering essential steps and prerequisites for making API requests. It is designed for users new to the Mist API.

```API
How to Get Started
```

--------------------------------

### Mist API Reference - Getting Started Guide

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/tunnel-provider-options-zscaler

Provides instructions on how to get started with the Mist API. This includes initial setup and basic usage guidelines for developers.

--------------------------------

### Mist API - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/zone-vertex

Provides introductory information and guidance on how to begin using the Mist API. This typically includes setup instructions, authentication methods, and basic examples for making API calls.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Mist API - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/sle-summary-sle-samples

This guide explains the initial steps required to begin using the Mist API, likely involving authentication and basic setup procedures.

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-switch-port-search

This guide provides instructions on how to get started with the Mist API. It covers initial setup, authentication, and basic API usage patterns.

```API
Authentication: Bearer Token
Base URL: https://api.mist.com/api/v1
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/site-wids

This section outlines the initial steps for using the Mist API, including how to get started and navigate through important guides. It covers API changes, overviews, request formats, webhooks, and websockets.

```HTTP
GET /api/v1/getting-started
GET /api/v1/guides/api-changes
GET /api/v1/guides/overview
GET /api/v1/guides/api-requests
GET /api/v1/guides/webhooks
GET /api/v1/guides/websockets
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/psks-import-file

This section provides guidance on how to get started with the Mist API, likely covering initial setup, authentication, and basic usage patterns. It serves as an entry point for developers new to the Mist API.

```API
Getting Started
How to Get Started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-search-var

This section provides guidance on how to begin using the Mist API, including initial setup and authentication procedures.

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/wlan-dynamic-psk

This section provides guidance on how to get started with the Mist API. It includes essential information for initial setup and integration.

```API
GET /api/v1/getting_started
```

--------------------------------

### Mist API - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/vrf-extra-route

Provides guidance on how to get started with the Mist API, including initial setup and common first steps for integration.

```API
GET /api/v1/getting_started
```

--------------------------------

### Mist API Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/utils-zeroize-fips

Guides users through the initial steps of using the Mist API, including important changes, overviews, request formats, webhooks, and websockets.

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/user-apitoken

This section provides guidance on how to begin using the Mist API, likely involving authentication and initial setup steps.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/map-sitesurvey-path-items

Provides introductory information and guides for using the Mist API, including how to get started and important API changes.

```API Spec
  * Getting Started
    * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/module-stat-item-poe

This section covers the initial steps for using the Mist API, including how to get started and important guides on API changes, requests, webhooks, and websockets.

```API Spec
## Getting Started
  * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/utils-show-dot-1-x

This section outlines the initial steps required to begin using the Mist API, including setup and basic configuration.

```API Spec
How to Get Started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/account-skyatp-data

This section provides guidance on how to get started with the Mist API, including initial setup and authentication procedures.

```HTTP
GET /api/v1/getting_started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-ap-radio-config-band

Provides guidance on how to begin using the Mist API, including initial setup and authentication procedures.

```API
GET /api/v1/getting_started
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/sle-impact-summary-ap-item

This section outlines the initial steps for using the Mist API, including how to get started and navigate through important guides such as API changes, requests, webhooks, and websockets.

```API Spec
## Getting Started
  * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/tunnel-provider-options-prisma

Provides guidance on how to get started with the Mist API, including initial setup and basic usage instructions.

```API
Getting Started
How to Get Started
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/coa-server

Provides guidance on initiating interaction with the Mist API, including 'Getting Started' steps and 'Guides' covering important API changes, overviews, request formats, webhooks, websockets, and 'How To' sections.

```API
Coa Server
  * Getting Started
    * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Quick Starts

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-wired/topics/topic-map/manage-template-settings-wired-assurance

This section offers quick start guides for various Juniper products and features, designed to help users get started rapidly.

```Juniper
Quick Starts
```

--------------------------------

### Mist API - Psk Portal Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/psk-portal

This guide outlines the initial steps required to begin using the Mist API, focusing on the Psk Portal. It covers essential setup and configuration for accessing API functionalities.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/fingerprint

Provides essential information for users beginning with the Mist API, including a 'Getting Started' guide and various 'Guides' covering important API changes, overviews, request formats, webhooks, websockets, and 'How To' sections.

```HTTP
HTTP
```

--------------------------------

### Mist API Reference - Getting Started Guide

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/snmp-config-client-list

This guide provides essential information for new users to begin interacting with the Mist API. It covers the initial setup and basic operations required to leverage the API's capabilities for network management.

```API
GET /api/v1/getting-started

```

--------------------------------

### Mist API Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/count-result

Provides essential information for users new to the Mist API, including a 'Getting Started' guide and various 'Guides' covering important API changes, general overviews, request methods, webhooks, websockets, and how-to instructions.

```API Spec
* Getting Started
    * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-pcap-search-item-pcap-aps-item

Provides essential information for users new to the Mist API, including a 'How to Get Started' guide and various informational guides on important API changes, overview, requests, webhooks, and websockets.

```API
Getting Started
  How to Get Started
Guides
  Important API Changes
  Overview
  API Requests
  Webhooks
  Websockets
  How To
```

--------------------------------

### Mist API Reference - Get Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/ap-template-wifi

This section refers to 'Getting Started' guides within the Mist API documentation, providing initial steps and information for users new to the API.

```API Spec
How to Get Started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/remote-syslog-file-config

Provides guidance on how to begin using the Mist API, including initial setup and authentication procedures.

```API
GET /api/v1/getting-started
```

--------------------------------

### Mist API - Getting Started Guide

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/search-wired-client

Provides an introductory guide on how to begin using the Mist API. This includes essential steps for authentication and making your first API requests.

```API
API Spec
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-events-rrm

This section provides guidance on how to begin using the Mist API, likely covering authentication, basic request structures, and initial setup steps.

```HTTP
GET /api/v1/getting-started

```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/switch-port-mirroring-property

Provides guidance on how to get started with the Mist API, including initial setup and basic usage instructions.

```API
Getting Started
How to Get Started
```

--------------------------------

### Webhook Device Events - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/webhook-device-events

This section guides users on how to get started with Webhook Device Events, which are crucial for real-time notifications about changes and events within the Mist network. It outlines the initial setup and configuration steps required to enable these events.

```API
POST /api/v1/webhooks/device_events
```

--------------------------------

### Mist API - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-auto-zone-zone-vertex

Provides essential information and steps for users new to the Mist API. It guides users through the initial setup and common tasks required to begin using the API for network management.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Mist API - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/evpn-topology-response

This section provides guidance on how to get started with the Mist API. It likely covers initial setup, authentication, and basic API calls to begin interacting with the Mist network management system.

```API
How to Get Started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/account-skyatp-info

Provides guidance on how to begin using the Mist API. This typically includes setup instructions, authentication methods, and initial API calls to verify connectivity.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/switch-port-usage-storm-control

This section provides guidance on how to get started with the Mist API, including initial setup and basic usage instructions.

```API
GET /api/v1/getting_started
```

--------------------------------

### Mist API - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/vrrp-group-network

This guide explains how to get started with the Mist API, outlining the initial steps and prerequisites for making API requests. It is essential for new users of the Mist platform.

```API
How to Get Started
```

--------------------------------

### Mist API Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/recover

This snippet summarizes the introductory and guidance sections of the Mist API Reference. It highlights key areas such as initial setup, important API changes, general overviews, request handling, webhooks, websockets, and how-to guides for using the API.

```API Spec
* Getting Started
    * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/routing-policy-term-matching-vpn-path-sla

Provides guidance on how to begin using the Mist API, including initial setup and authentication procedures. This section is crucial for developers new to the Mist platform.

```API
GET /api/v1/getting_started
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-cluster-config-ethernet-connection-item

This section outlines the initial steps for using the Mist API, including how to get started and navigate important changes. It also covers general API requests, webhooks, and websockets for real-time data and event handling.

```HTTP
GET /api/v1/getting-started
GET /api/v1/guides/api-changes
GET /api/v1/api-requests
POST /api/v1/webhooks
GET /api/v1/websockets
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/rrm-neighbors

This section outlines the initial steps for using the Mist API, including how to get started and navigate important guides. It covers API changes, overviews, request formats, webhooks, websockets, and general how-to information.

```API
API Spec
HTTP
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/evpn-topology-switch-config

Provides guidance on how to begin using the Mist API. This includes initial setup and essential steps for API integration.

```API
Getting Started
How to Get Started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/dhcpd-config-property

Provides guidance on how to begin using the Mist API. This includes essential steps and information for initial setup and integration.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/ap-pwr-config

Provides guidance on how to begin using the Mist API, including initial setup and authentication procedures.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Get Started with Mist API

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/capture-wireless

Provides guidance on how to begin using the Mist API, including initial setup and common tasks.

```API Spec
Getting Started
How to Get Started
```

--------------------------------

### Mist API - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/config-vc-port-member

Provides guidance on how to begin using the Mist API. This includes initial setup, authentication, and making your first API requests to interact with the Mist platform.

```HTTP
GET /api/v1/getting_started
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/gateway-path-preferences

This section outlines the initial steps for using the Mist API and provides guides on important API changes, general overview, making API requests, and handling webhooks and websockets.

```API
API Requests
Webhooks
Websockets
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/webhook-location

Provides guidance on how to begin using the Mist API, including initial setup and essential steps for accessing API functionalities.

```API
Getting Started
How to Get Started
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-switch-ap-redundancy-module

Provides essential information for users new to the Mist API, including a 'Getting Started' guide and details on important API changes. It also covers fundamental concepts like API requests, webhooks, and websockets for real-time data and event handling.

```API
Getting Started
How to Get Started
Guides
Important API Changes
Overview
API Requests
Webhooks
Websockets
How To
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/dswitches-metrics-version-compliance

This section outlines the initial steps for using the Mist API, including how to get started and navigate important API changes. It also covers guides on API requests, webhooks, websockets, and general 'how-to' information.

```API Spec
## Mist API Reference
  * Getting Started
    * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Mist API - Get Started and Overview

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/ha-cluster-config

This section provides introductory information on how to get started with the Mist API, including guides on making API requests and understanding important changes. It serves as a foundational resource for developers.

```HTTP
GET /api/v1/getting-started
GET /api/v1/overview
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-claim-license-inventory-pending-item

This section outlines the initial steps required to begin using the Mist API. It typically covers authentication, basic request structures, and essential setup procedures for interacting with the API.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/org-setting-gateway-mgmt-host-out-policies

This section outlines the initial steps for using the Mist API and provides guides on important changes, general overview, making API requests, and utilizing webhooks and websockets. It serves as a starting point for developers interacting with the Mist platform.

```HTTP
GET /api/v1/orgs/{org_id}/settings/gateway_mgmt/host_out_policies
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-discovered-switches

This section provides guidance on how to get started with the Mist API, including important changes and overviews of API requests, webhooks, and websockets.

```API
Getting Started
How to Get Started
Guides
Important API Changes
Overview
API Requests
Webhooks
Websockets
How To
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-count-marvis-actions-result

This section outlines the initial steps for using the Mist API, including how to get started and important considerations like API changes. It also covers essential guides on making API requests, setting up webhooks, and utilizing websockets for real-time communication.

```HTTP
GET /api/v1/getting_started
GET /api/v1/guides/api_changes
GET /api/v1/guides/api_requests
POST /api/v1/webhooks
GET /api/v1/websockets
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/tunterm-port-config

Provides guidance on how to begin using the Mist API, including initial setup and essential steps for making your first API requests.

```API
Getting Started
How to Get Started
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/ap-antenna-mode

This section covers the initial steps for using the Mist API, including how to get started and important guides on API changes, requests, webhooks, and websockets. It's essential for understanding the API's capabilities and best practices.

```API
Getting Started
How to Get Started
Guides
Important API Changes
Overview
API Requests
Webhooks
Websockets
How To
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-device-other-connected-device

This section provides guidance on how to begin using the Mist API, likely covering authentication, basic request structures, and initial setup steps.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/suppressed-alarm-applies

Provides guidance on how to begin using the Mist API, including essential steps and initial setup instructions. This is crucial for developers new to the platform.

```Mist API
Getting Started
How to Get Started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/switch-matching-rule-ip-config

Provides guidance on how to begin using the Mist API. This includes initial setup, authentication, and making your first API requests to the Juniper Mist platform.

```HTTP
GET /api/v1/getting_started
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/rrm-neighbors-neighbor

This section outlines the initial steps for using the Mist API, including how to get started and navigate important API changes. It also covers general guides on API requests, webhooks, websockets, and how-to articles.

--------------------------------

### Mist API - Get Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/switch-mist-nac

This section outlines the initial steps for using the Mist API and provides guides on important API changes, general overviews, request formats, webhooks, websockets, and how-to guides.

```API
GET /api/v1/getting-started
GET /api/v1/guides/api-changes
GET /api/v1/guides/overview
GET /api/v1/guides/api-requests
GET /api/v1/guides/webhooks
GET /api/v1/guides/websockets
GET /api/v1/guides/how-to
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-dswitches-metrics

This section outlines the initial steps for using the Mist API and provides guides on key features like API changes, requests, webhooks, and websockets. It serves as an entry point for developers interacting with the Mist platform.

```HTTP
GET /api/v1/getting_started
GET /api/v1/guides/api_changes
GET /api/v1/guides/api_requests
GET /api/v1/guides/webhooks
GET /api/v1/guides/websockets
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/gateway-port-mirroring-port-mirror

Provides introductory information and guides on how to begin using the Mist API. This includes essential steps for authentication and making your first API requests.

```API
How to Get Started
```

--------------------------------

### Mist API - Get Started Guide

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/device-search-radius-stat

Provides guidance on how to begin using the Mist API. This typically involves authentication and basic request structures.

```HTTP
GET /api/v1/gettingstarted
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/switch-virtual-chassis

This snippet covers the initial steps for using the Mist API and important guides for understanding API changes and functionalities. It includes sections on API requests, webhooks, and websockets.

```HTTP
GET /api/v1/getting-started
GET /api/v1/guides/api-changes
GET /api/v1/guides/overview
GET /api/v1/guides/api-requests
GET /api/v1/guides/webhooks
GET /api/v1/guides/websockets
```

--------------------------------

### Webhook Occupancy Alerts - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/webhook-occupancy-alerts

This section guides users on how to get started with setting up and utilizing webhook occupancy alerts within the Mist API. It outlines the initial steps and prerequisites for integrating this feature.

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/junos-port-config

Provides guidance on how to begin using the Mist API. This includes initial setup, authentication, and making your first API calls to interact with the Mist platform.

```API
GET /api/v1/getting-started
```

--------------------------------

### Webhook Device Events - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/webhook-device-events-event

This section provides guidance on how to get started with receiving device events via webhooks from the Mist API. It outlines the initial steps and setup required for integrating webhook notifications.

```HTTP
POST /api/v1/webhooks
Content-Type: application/json

{
  "url": "https://your-webhook-receiver.com/event",
  "events": ["device_up", "device_down"]
}
```

--------------------------------

### Getting Started with Mist API

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/optic-port-config-port

Provides guidance on how to begin using the Mist API. This typically includes initial setup, authentication, and making basic API calls.

```API Spec
How to Get Started
```

--------------------------------

### Mist API - Getting Started and Overview

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-wxrule

This section outlines the initial steps for interacting with the Mist API and provides a general overview of its capabilities. It serves as a starting point for developers and administrators.

```API
## Getting Started
  * How to Get Started
  ## Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/wired-client-response-device-mac-port-item

This section outlines the initial steps for using the Mist API and provides access to important guides covering API changes, overviews, requests, webhooks, websockets, and general how-to information.

```API Spec
## Mist API Reference
  * HTTP
  * HTTP
  * API Spec

* * *
Wired Client Response Device Mac Port Item
  * Getting Started
    * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/gateway-port-config-ip-config

Provides guidance on how to begin using the Mist API. This includes initial setup and essential steps for making your first API requests.

```API Spec
Getting Started
How to Get Started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/ap-radio-band-5

This section provides introductory information on how to get started with the Mist API, outlining the initial steps and prerequisites for API interaction.

```API
## Getting Started
  * How to Get Started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/tunnel-config-probe

Provides guidance on how to begin using the Mist API, including essential steps and initial setup procedures for accessing and utilizing the API's functionalities.

```API
Getting Started
How to Get Started
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/wan-usages

Provides guidance on initiating API interactions and understanding key changes and concepts within the Mist API, including webhooks and websockets.

```API
Wan Usages
Getting Started
How to Get Started
Guides
Important API Changes
Overview
API Requests
Webhooks
Websockets
How To
```

--------------------------------

### Mist API - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-org-suppress-alarm

Provides an overview of how to get started with the Mist API and guides on important API changes, general usage, making API requests, and utilizing webhooks and websockets for real-time data.

```Mist API
Getting Started
How to Get Started
Guides
Important API Changes
Overview
API Requests
Webhooks
Websockets
How To
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-rrm-neighbors

This section outlines the initial steps for using the Mist API, including how to get started and navigate through important guides. It covers API changes, requests, webhooks, websockets, and general how-to information.

```API Spec
## Mist API Reference
  * HTTP
  * HTTP
  * API Spec

* * *
Response Rrm Neighbors
  * Getting Started
    * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Mist API Reference Overview

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/site-setting-analytic

This section outlines the structure and content of the Mist API Reference, including guides on getting started, important API changes, and general overviews. It serves as an entry point for understanding the API's capabilities.

--------------------------------

### Mist API - Get Started and Overview

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/sle-impacted-applications

This section outlines the initial steps for interacting with the Mist API and provides a general overview of its capabilities. It serves as a starting point for developers looking to integrate with the Mist platform.

```HTTP
GET /api/v1/getting_started
GET /api/v1/overview
```

--------------------------------

### Mist API Reference Overview

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/site-app

This section outlines the structure and content of the Mist API Reference, including guides on getting started, API requests, webhooks, and websockets. It serves as an entry point for understanding and utilizing the Mist API.

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-mxedge

This section provides guidance on how to begin using the Mist API. It outlines the initial steps and prerequisites for making API requests.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/gateway-mgmt-host-out-policy-syslog

This section provides guidance on how to begin using the Mist API. It outlines the initial steps and prerequisites for making API requests and interacting with the Mist platform.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Access Mist API Documentation

Source: https://www.juniper.net/documentation/us/en/software/mist/product-updates/2019/january-31st-2019-updates

Provides a direct link to the Juniper Mist API documentation for getting started with network programming. It also references a section on the documentation site for automation with APIs, including instructions and use case examples.

```URL
https://www.juniper.net/documentation/us/en/software/mist/api/http/getting-started/how-to-get-started
```

```URL
https://www.juniper.net/documentation/product/us/en/mist/#cat=for_developers
```

--------------------------------

### Mist API Reference - Getting Started and Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-wan-tunnel

This section outlines the initial steps for using the Mist API, including how to get started and navigate important API changes. It also covers guides on API requests, webhooks, websockets, and general 'how-to' information.

```API Spec
## Mist API Reference
  * HTTP
  * HTTP
  * API Spec

* * *
Stats Wan Tunnel
  * Getting Started
    * How to Get Started
  * Guides
    * Important API Changes
    * Overview
    * API Requests
    * Webhooks
    * Websockets
    * How To
```

--------------------------------

### Configure Basic OSPF in EX Devices

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-wired/topics/task/configure-bridge-priority

This snippet refers to an example demonstrating how to configure basic OSPF settings on two EX Series devices. It serves as a practical guide for implementing OSPF.

```text
Example: Configure Basic OSPF in two EX Devices
```

--------------------------------

### Example API Request for Virtual Chassis Conversion

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-wired/topics/topic-map/vc-configure-manage-ex2300-ex4650-qfx5120-tm

An example of a POST request to the Mist API for converting a Virtual Chassis to a virtual MAC address. This example includes a sample site ID and device ID.

```http
POST https://api.mist.com/api/v1/sites/978c48e6-6ef6-11e6-8bbf-02e208b2d34f/devices/00000000-0000-0000-1000-a4e11a000000/vc/convert_to_virtualmac
```

--------------------------------

### Marvis Conversational Assistant - List Apps Examples

Source: https://www.juniper.net/documentation/us/en/software/mist/product-updates/2022/february-25th-2022-updates

Examples of queries to ask the Marvis Conversational Assistant to list applications associated with sites, APs, or clients. Marvis provides redirection links to relevant UI pages for detailed application information.

```Natural Language
list Apps
```

```Natural Language
show apps for <AP mac>
```

```Natural Language
most used apps in site <sitename>
```

```Natural Language
what apps client <clientname> accessed
```

--------------------------------

### Marvis: Conversational Assistant - Org Template Example

Source: https://www.juniper.net/documentation/us/en/software/mist/product-updates/2021/july-29th-2021-updates

Illustrates the use of the Marvis Conversational Assistant to understand organizational templates. The example query 'what’s an org template' is provided, explaining that the assistant will list supported templates and link to the relevant page.

```English
what’s an org template
```

--------------------------------

### Example API Request for Virtual Chassis Conversion

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-wired/topics/topic-map/modify-vc-preprovisioned

An example of a POST request to the Mist API for converting a Virtual Chassis to a virtual MAC address. This example includes a sample site ID and device ID.

```http
POST https://api.mist.com/api/v1/sites/978c48e6-6ef6-11e6-8bbf-02e208b2d34f/devices/00000000-0000-0000-1000-a4e11a000000/vc/convert_to_virtualmac
```

--------------------------------

### Mist API Reference - How To Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/response-events-rrm

This section provides step-by-step instructions and practical examples for performing various tasks using the Mist API.

```HTTP
GET /api/v1/guides/how-to

```

--------------------------------

### Time to Connect Summary Request Example

Source: https://www.juniper.net/documentation/us/en/software/mist/automation-integration/topics/concept/api-mist-metrics

An example of a GET request to the Mist API for the 'Time to Connect' summary. It shows how to specify the site ID and includes parameters for start, end, and duration.

```http
https://api.gc2.mist.com/api/v1/sites/aee83225-1773-4e55-af64-c8b5a86b1fa6/sle/site/aee83225-1773-4e55-af64-c8b5a86b1fa6/metric/time-to-connect/summary?start&end&duration
```

--------------------------------

### RRM Usage Examples

Source: https://www.juniper.net/documentation/us/en/software/mist/wireless/mist-wireless-configuration/index

Provides practical examples of how to use and configure Radio Resource Management (RRM) in Juniper Mist.

```text
RRM Usage Examples
```

--------------------------------

### License Guide

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-wired/topics/topic-map/manage-template-settings-wired-assurance

This documentation provides information and guidance on licensing for Juniper products and services.

```Juniper
License Guide
```

--------------------------------

### RRM Usage Examples

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-wireless/index

Provides practical examples of how to use and configure Radio Resource Management (RRM) in Juniper Mist.

```text
RRM Usage Examples
```

--------------------------------

### Accessing Documentation and Resources

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-wireless/topics/topic-map/manage-aps

Provides access to documentation, quick starts, validated designs, and developer resources for Juniper Mist Wireless Assurance.

--------------------------------

### Mist API - Get Started and Overview

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/org-setting-gateway-mgmt-host-in-policies

This section covers the initial steps for interacting with the Mist API, including how to get started and an overview of the API's capabilities. It's essential for understanding the basic structure and authentication methods.

```API
GET /api/v1/getting-started
GET /api/v1/overview
```

--------------------------------

### Deploy and Manage EX Series Switches at a Branch

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-wired/topics/concept/wired-initial-config

This guide provides instructions for deploying and managing Juniper EX Series switches specifically in a branch office environment using Mist. It covers the setup and ongoing management considerations for branch networks.

```Mist AI
Deploy and Manage EX Series Switches at a Branch
```

--------------------------------

### Mist API Reference - How To Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/wlan-dynamic-psk

This section provides step-by-step instructions and practical examples for various tasks using the Mist API.

```API
GET /api/v1/guides/how_to
```

--------------------------------

### Mist API Reference Overview

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/sdktemplate

This section outlines the structure and content of the Mist API reference, including sections on getting started, guides, walkthroughs, API endpoints, and data models. It serves as a high-level guide to navigating the API documentation.

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/switch-metrics-active-ports-summary-details

Provides guidance on how to begin using the Mist API. This typically involves authentication and basic request structures.

```HTTP
GET /api/v1/getting_started
```

--------------------------------

### Site Capacity API Sample Request

Source: https://www.juniper.net/documentation/us/en/software/mist/automation-integration/images/newconcept

Example of a GET request to the Juniper Mist API for site capacity, including parameters for start, end, and duration.

```bash
https://api.gc2.mist.com/api/v1/sites/aee83225-1773-4e55-af64-c8b5a86b1fa6/sle/site/aee83225-1773-4e55-af64-c8b5a86b1fa6/metric/capacity/summary?start&end&duration
```

--------------------------------

### Mist API Reference - Getting Started

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/switch-dhcpd-config-property

Provides guidance on how to begin using the Mist API. This includes essential steps for authentication and making initial API requests to interact with the Mist platform.

```HTTP
GET /api/v1/getting-started
```

--------------------------------

### Insight Metrics Response (JSON)

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/insights/get-site-insight-metrics-for-client

This is an example JSON response structure for the 'Get Site Insight Metrics for Client' API call. It includes fields for the start and end timestamps of the data, the interval between data points, and an array of results.

```JSON
{
"end": 0,
"interval": 0,
"results": [
    {}
  ],
"start": 0
}
```

--------------------------------

### Sample Request for Throughput Summary

Source: https://www.juniper.net/documentation/us/en/software/mist/automation-integration/topics/concept/restful-api-overview

An example of a GET request to the Mist API for retrieving a summary of throughput metrics for a site. It includes parameters for start, end, and duration.

```http
https://api.gc2.mist.com/api/v1/sites/aee83225-1773-4e55-af64-c8b5a86b1fa6/sle/site/aee83225-1773-4e55-af64-c8b5a86b1fa6/metric/throughput/summary?start&end&duration
```

--------------------------------

### RRM Usage Examples in Juniper

Source: https://www.juniper.net/documentation/us/en/software/mist/mist-wireless/topics/concept/guest-portal-labels

No description

--------------------------------

### Mist API - How To Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/stats-wireless-client

A collection of 'how-to' guides for performing specific tasks using the Mist API, offering practical examples and step-by-step instructions.

```API
How To
```

--------------------------------

### Sample Request for Throughput Summary

Source: https://www.juniper.net/documentation/us/en/software/mist/automation-integration/topics/concept/rest-api-http-response-codes

An example of a GET request to the Mist API for retrieving a summary of throughput metrics for a site. It includes parameters for start, end, and duration.

```http
https://api.gc2.mist.com/api/v1/sites/aee83225-1773-4e55-af64-c8b5a86b1fa6/sle/site/aee83225-1773-4e55-af64-c8b5a86b1fa6/metric/throughput/summary?start&end&duration
```

--------------------------------

### API Request Examples

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/installer-provision-device

Provides examples of common API requests for interacting with the Mist platform. These examples demonstrate how to retrieve data, configure settings, and manage network resources.

```HTTP
GET /api/v1/sites
Accept: application/json
```

```HTTP
GET /api/v1/devices?site_id=<site_id>
Accept: application/json
```

--------------------------------

### Sample Request for Throughput Summary

Source: https://www.juniper.net/documentation/us/en/software/mist/automation-integration/images/newconcept

An example of a GET request to the Mist API for retrieving a summary of throughput metrics for a site. It includes parameters for start, end, and duration.

```http
https://api.gc2.mist.com/api/v1/sites/aee83225-1773-4e55-af64-c8b5a86b1fa6/sle/site/aee83225-1773-4e55-af64-c8b5a86b1fa6/metric/throughput/summary?start&end&duration
```

--------------------------------

### How To Guides

Source: https://www.juniper.net/documentation/us/en/software/mist/api/http/models/structures/account-juniper-config

This section offers practical guides and instructions on how to perform various tasks using the Mist API.

--------------------------------

### API Request Example for Dynamic VLANs

Source: https://www.juniper.net/documentation/us/en/software/mist/product-updates/2019/april-26th-2019-updates

This example demonstrates a PUT request to the Juniper Networks Mist API for configuring dynamic VLANs. It shows the endpoint and the JSON body containing the dynamic VLAN settings.

```bash
PUT /api/v1/sites/:site_id/setting

DYNAMIC_VLANS = "{\"enabled\": true,\"type\": \"airespace-interface-name\",\"vlans\":{\"131\": \"default\",\"322\": \"fast,video\"}\"default_vlan_id\": 999,\"local_vlan_ids\": []}"
```
Tokens:
Raw