Metadata-Version: 2.4
Name: juniper-mist-sdk
Version: 0.0.1
Summary: Jmist SDKs by APIMatic
Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
Project-URL: Documentation, https://www.juniper.net/documentation/us/en/software/mist/api/http/getting-started/how-to-get-started
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: apimatic-core>=0.2.24,~=0.2.0
Requires-Dist: apimatic-core-interfaces>=0.1.8,~=0.1.0
Requires-Dist: apimatic-requests-client-adapter>=0.1.10,~=0.1.0
Requires-Dist: python-dotenv<2.0,>=0.21
Provides-Extra: testutils
Requires-Dist: pytest>=7.2.2; extra == "testutils"
Requires-Dist: pytest-django<5,>=4.5.2; extra == "testutils"
Requires-Dist: Django~=3.2.25; python_version < "3.13" and extra == "testutils"
Requires-Dist: Django~=5.1.3; python_version >= "3.13" and extra == "testutils"
Requires-Dist: Flask~=2.2.5; extra == "testutils"
Requires-Dist: fastapi~=0.95.2; extra == "testutils"
Requires-Dist: httpx~=0.24.1; extra == "testutils"
Requires-Dist: anyio~=3.7.1; extra == "testutils"
Requires-Dist: typing-extensions~=4.7.1; extra == "testutils"
Requires-Dist: Werkzeug<3.0,>=2.2; extra == "testutils"
Dynamic: license-file


# Getting Started with Mist API

## Introduction

> Version: **2604.1.1**
> 
> Date: **May 13, 2026**

<div class="notification"> NOTE:<br>Some important API changes will be introduced. Please make sure to read the <a href="https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/important-api-changes">announcements</a> </div>


---


### Additional Documentation

* [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html)
* [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location-services/topics/concept/mist-how-get-mist-sdk.html)
* [Mist Product Updates](https://www.juniper.net/documentation/us/en/software/mist/product-updates/)

### Helpful Resources

* [API Sandbox and Exercises](https://api-class.mist.com/)
* [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace)
* [Python Script Examples](https://github.com/tmunzer/mist_library)
* [API Demo Apps](https://apps.mist-lab.fr/)
* [Juniper Blog](https://blogs.juniper.net/)

### Mist Web Browser Extension:

* Google Chrome, Microsoft Edge and other Chromium-based browser: [Chrome Web Store](https://chromewebstore.google.com/detail/mist-extension/ejhpdcljeamillfhdihkkmoakanpbplh)
* Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mist-extension/)

---


## Install the Package

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

```bash
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.](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| accept | `str` | *Default*: `"application/json, application/vnd.api+json"` |
| environment | [`Environment`](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/README.md#environments) | The API environment. <br> **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. <br> **Default: 60** |
| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **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. <br> **Default: ["GET", "PUT"]** |
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| api_token_credentials | [`ApiTokenCredentials`](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
| csrf_token_credentials | [`CsrfTokenCredentials`](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
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

```python
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](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/environment-based-client-initialization.md) 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)`](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/auth/custom-header-signature.md)
* [`basicAuth (Basic Authentication)`](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/auth/basic-authentication.md)
* [`csrfToken (Custom Header Signature)`](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/auth/custom-header-signature-1.md)

## List of APIs

* [Admins](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/admins.md)
* [Admins Login](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/admins-login.md)
* [Admins Login-O Auth 2](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/admins-login-o-auth-2.md)
* [Admins Logout](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/admins-logout.md)
* [Admins Lookup](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/admins-lookup.md)
* [Constants Definitions](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/constants-definitions.md)
* [Constants Events](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/constants-events.md)
* [Constants Models](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/constants-models.md)
* [Installer](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/installer.md)
* [MS Ps](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps.md)
* [MS Ps Admins](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-admins.md)
* [MS Ps Inventory](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-inventory.md)
* [MS Ps Licenses](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-licenses.md)
* [MS Ps Logo](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-logo.md)
* [MS Ps Logs](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-logs.md)
* [MS Ps Marvis](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-marvis.md)
* [MS Ps Org Groups](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-org-groups.md)
* [MS Ps Orgs](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-orgs.md)
* [MS Ps SL Es](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-sl-es.md)
* [MS Ps SSO](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-sso.md)
* [MS Ps SSO Roles](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-sso-roles.md)
* [MS Ps Tickets](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/ms-ps-tickets.md)
* [Orgs SDK Invites](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/orgs-sdk-invites.md)
* [Utilities Wi-Fi](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/controllers/utilities-wi-fi.md)

## Webhooks

* [Webhooks](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/events/webhooks/webhooks-handler.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/environment-based-client-initialization.md)
* [AbstractLogger](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/abstract-logger.md)
* [LoggingConfiguration](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/response-logging-configuration.md)

### HTTP

* [HttpResponse](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/http-request.md)
* [Request](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/request.md)

### Utilities

* [ApiResponse](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/api-response.md)
* [ApiHelper](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/sdks-io/juniper-mist-python-sdk-2/tree/0.0.1/doc/unix-date-time.md)

