Skip to main content

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

Helpful Resources

Mist Web Browser Extension:


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.

List of APIs

Webhooks

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for juniper-mist-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for juniper-mist-sdk 0.0.1
File Size Uploaded Provenance Actions
juniper_mist_sdk-0.0.1.tar.gz 915.2 kB Without provenance Details for juniper_mist_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for juniper-mist-sdk 0.0.1
File Interpreter ABI Platform Actions
juniper_mist_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for juniper_mist_sdk-0.0.1-py3-none-any.whl

Total release size: 3.1 MB

Release files / juniper_mist_sdk-0.0.1.tar.gz

Download URL juniper_mist_sdk-0.0.1.tar.gz
Size 915.2 kB
Tags Source
SHA-256 checksum
How to use checksums
257013de2df26fbe66fa2e679ca8d3957f9156080ae07a2f10ba747773acd204
BLAKE2b-256 checksum
How to use checksums
7614d1fd75c8ee41d9811cc470684eb756ff7ee6fcffe07fb22d124eeefe0d34
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / juniper_mist_sdk-0.0.1-py3-none-any.whl

Download URL juniper_mist_sdk-0.0.1-py3-none-any.whl
Size 2.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
5d39040c077e53b90ae7560a99c478099caed3fa8c1b188ae82b1af66159e8f8
BLAKE2b-256 checksum
How to use checksums
556c0c59a044ce87808757c1863b0c98cc9447ecb2c9b994c800f08ccb13a9d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for juniper-mist-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page