juniper-mist-sdk 0.0.1

Jmist SDKs by APIMatic

Getting Started with Mist API

Introduction

Version: 2604.1.1

Date: May 13, 2026

NOTE:
Some important API changes will be introduced. Please make sure to read the announcements

---

Additional Documentation

• Mist Automation Guide
• Mist Location SDK
• Mist Product Updates

Helpful Resources

• API Sandbox and Exercises
• Postman Collection, Runners and Webhook Samples
• Python Script Examples
• API Demo Apps
• Juniper Blog

Mist Web Browser Extension:

• Google Chrome, Microsoft Edge and other Chromium-based browser: Chrome Web Store
• Firefox: Firefox Add-ons

---

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install juniper-mist-sdk==0.0.1

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

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
accept	str	Default: "application/json, application/vnd.api+json"
environment	Environment	The API environment. Default: Environment.MIST_GLOBAL_01
http_client_instance	Union[Session, HttpClientProvider]	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"]
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
api_token_credentials	ApiTokenCredentials	The credential object for Custom Header Signature
basic_auth_credentials	BasicAuthCredentials	The credential object for Basic Authentication
csrf_token_credentials	CsrfTokenCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from mistapi.configuration import Environment
from mistapi.http.auth.api_token import ApiTokenCredentials
from mistapi.http.auth.basic_auth import BasicAuthCredentials
from mistapi.http.auth.csrf_token import CsrfTokenCredentials
from mistapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from mistapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from mistapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from mistapi.mist_api_client import MistApiClient

client = MistApiClient(
    accept='application/json, application/vnd.api+json',
    api_token_credentials=ApiTokenCredentials(
        authorization='Authorization'
    ),
    basic_auth_credentials=BasicAuthCredentials(
        username='Username',
        password='Password'
    ),
    csrf_token_credentials=CsrfTokenCredentials(
        x_csrf_token='X-CSRFToken'
    ),
    environment=Environment.MIST_GLOBAL_01,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from mistapi.mist_api_client import MistApiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = MistApiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

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

Fields

Name	Description
MIST_GLOBAL_01	Default
MIST_GLOBAL_02	-
MIST_GLOBAL_03	-
MIST_GLOBAL_04	-
MIST_GLOBAL_05	-
MIST_EMEA_01	-
MIST_EMEA_02	-
MIST_EMEA_03	-
MIST_EMEA_04	-
MIST_APAC_01	-
MIST_APAC_02	-
MIST_APAC_03	-

Authorization

This API uses the following authentication schemes.

• apiToken (Custom Header Signature)
• basicAuth (Basic Authentication)
• csrfToken (Custom Header Signature)

List of APIs

• Admins
• Admins Login
• Admins Login-O Auth 2
• Admins Logout
• Admins Lookup
• Constants Definitions
• Constants Events
• Constants Models
• Installer
• MS Ps
• MS Ps Admins
• MS Ps Inventory
• MS Ps Licenses
• MS Ps Logo
• MS Ps Logs
• MS Ps Marvis
• MS Ps Org Groups
• MS Ps Orgs
• MS Ps SL Es
• MS Ps SSO
• MS Ps SSO Roles
• MS Ps Tickets
• Orgs SDK Invites
• Utilities Wi-Fi

Webhooks

• Webhooks

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest
• Request

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime