sdksio-juniper-mist-sdk 1.0.0

Use the Juniper Mist SDK to automate many Mist processes by using the RESTful API, webhooks, and the WebSocket API.

Getting Started with Mist API

Introduction

Version: 2306.2.8

Date: July 10, 2023

---

Available Documentation

• Postman
• Open API

---

Useful links

• Mist Homepage
• Mist Documentation
• Official API Documentation (Mist account required)
• Mist Blog
• Mist Updates

Install the Package

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install sdksio-juniper-mist-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/sdksio-juniper-mist-sdk/1.0.0

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt
pytest

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. Default: Environment.PRODUCTION
http_client_instance	HttpClient	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
authorization	string	Auth Header. Replace {x-auth-key} with your Auth Key. Default: 'Token {x-auth-key}'

The API client can be initialized as follows:

from mistapi.mistapi_client import MistapiClient
from mistapi.configuration import Environment

client = MistapiClient(
    authorization='Token {x-auth-key}'
)

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
production	Default Mist Global 01
environment2	Mist Global 02
environment3	Mist Global 03
environment4	Mist Global 04
environment5	Mist Europe 01

Authorization

This API uses Custom Header Signature.

List of APIs

• Login With O Auth 2
• API Token
• Msps Admins
• Msps Inventory
• Msps Invites
• Msps Logo
• Msps Logs
• Msps Licenses
• Msps Marvis
• Msps Org Groups
• Msps Orgs
• Msps SL Es
• Msps SSO Roles
• Msps SSO
• Msps Stats
• Msps Tickets
• Orgs Admins
• Sites Alarms
• Sites Applications
• Sites Anomaly
• Sites Asset Filters
• Sites Assets
• Sites Beacons
• Sites Calls
• Sites Clients-Wan
• Sites Clients-Wired
• Sites Clients-Wireless
• Sites Devices
• Sites Devices-Wireless
• Sites Devices Others
• Sites Devices-Wired
• Sites Devices-Wired Virtual Chassis
• Sites Devices-WAN
• Sites Devices-WANHA
• Sites Devices Stats
• Sites Devices Upgrades
• Sites Devices Utilities
• Sites Events
• Sites EVPN Topologies
• Sites Guests
• Sites Insights
• Sites Licenses
• Sites Location
• Sites Maps
• Sites Maps Auto-Orientation
• Sites Maps Auto-Placement
• Sites Mx Edges
• Sites Mx Tunnels
• Sites Networks
• Sites Pcaps
• Sites Psks
• Sites Rfdiags
• Sites Rogues
• Sites RRM
• Sites Rssizones
• Sites Services
• Sites Service Policies
• Sites Setting
• Sites Skyatp
• Sites SL Es
• Sites Stats
• Sites Subscriptions
• Sites Synthetic Tests
• Sites UI Settings
• Sitesv Beacons
• Sites VP Ns
• Sites Webhooks
• Sites Wlans
• Sites Wx Rules
• Sites Wx Tags
• Sites Wx Tunnels
• Sites Zones
• Webhook Samples
• Orgs Admin
• Login
• Installer
• Admin
• Mobile
• Msps
• Sites
• Constants
• Self

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest