mistapi 0.61.3__tar.gz → 0.61.4__tar.gz

{mistapi-0.61.3 → mistapi-0.61.4}/.gitmodules

@@ -1,4 +1,4 @@
 [submodule "mist_openapi"]
 	path = mist_openapi
 	url = https://github.com/mistsys/mist_openapi.git
-	branch = 2602.1.8
+	branch = master

{mistapi-0.61.3 → mistapi-0.61.4}/CHANGELOG.md

@@ -1,4 +1,56 @@
 # CHANGELOG
+## Version 0.61.4 (April 2026)
+
+**Released**: April 1, 2026
+
+This release improves WebSocket reconnection, hardens credential handling, and fixes the two-factor authentication flow.
+
+---
+
+### 1. NEW FEATURES
+
+#### **Capped Reconnect Backoff (`max_reconnect_backoff`)**
+The `_MistWebsocket` client now supports a `max_reconnect_backoff` parameter to cap the exponential backoff delay during reconnection attempts:
+
+```python
+ws = mistapi.websockets.sites.DeviceStatsEvents(
+    apisession,
+    site_ids=["<site_id>"],
+    auto_reconnect=True,
+    max_reconnect_backoff=60.0  # Cap backoff at 60 seconds
+)
+```
+
+#### **Unlimited Reconnect Attempts**
+Setting `max_reconnect_attempts=0` now enables unlimited reconnection attempts:
+
+```python
+ws = mistapi.websockets.sites.DeviceStatsEvents(
+    apisession,
+    site_ids=["<site_id>"],
+    auto_reconnect=True,
+    max_reconnect_attempts=0  # Reconnect indefinitely
+)
+```
+
+---
+
+### 2. IMPROVEMENTS
+
+#### **Credential Override Logging**
+`APISession` now logs INFO-level messages when credentials (host, email, password, API token) are overridden by:
+- Constructor parameters overriding environment variables
+- Vault secrets overriding previously loaded values
+- Keyring credentials overriding previously loaded values
+
+#### **Security: Password Cleared After Login**
+The stored password is now cleared from memory immediately after successful login authentication.
+
+#### **User Attribute Handling**
+`APISession._getself()` now only sets a fixed set of known user-related attributes instead of setting every response key as an object attribute.
+
+---
+
 ## Version 0.61.3 (March 2026)
 
 **Released**: March 18, 2026

{mistapi-0.61.3 → mistapi-0.61.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mistapi
-Version: 0.61.3
+Version: 0.61.4
 Summary: Python package to simplify the Mist System APIs usage
 Project-URL: Source, https://github.com/tmunzer/mistapi_python
 Project-URL: Bug Tracker, https://github.com/tmunzer/mistapi_python/issues

{mistapi-0.61.3 → mistapi-0.61.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "mistapi"
-version = "0.61.3"
+version = "0.61.4"
 authors = [{ name = "Thomas Munzer", email = "tmunzer@juniper.net" }]
 description = "Python package to simplify the Mist System APIs usage"
 keywords = ["Mist", "Juniper", "API"]

{mistapi-0.61.3 → mistapi-0.61.4}/src/mistapi/__api_session.py

@@ -157,12 +157,28 @@ class APISession(APIRequest):
         self._session.proxies.update(filtered_proxies)
 
         if host:
+            if self._cloud_uri:
+                LOGGER.info(
+                    "apisession:__init__: overriding previously loaded MIST_HOST with constructor parameter"
+                )
             self.set_cloud(host)
         if email:
+            if self.email:
+                LOGGER.info(
+                    "apisession:__init__: overriding previously loaded MIST_USER with constructor parameter"
+                )
             self.set_email(email)
         if password:
+            if self._password:
+                LOGGER.info(
+                    "apisession:__init__: overriding previously loaded MIST_PASSWORD with constructor parameter"
+                )
             self.set_password(password)
         if apitoken:
+            if self._apitoken:
+                LOGGER.info(
+                    "apisession:__init__: overriding previously loaded MIST_APITOKEN with constructor parameter"
+                )
             self.set_api_token(apitoken)
         self.first_name: str = ""
         self.last_name: str = ""
@@ -244,10 +260,18 @@ class APISession(APIRequest):
             mist_host = read_response["data"]["data"].get("MIST_HOST", None)
             LOGGER.info("apisession:_load_vault: MIST_HOST=%s", mist_host)
             if mist_host:
+                if self._cloud_uri:
+                    LOGGER.info(
+                        "apisession:_load_vault: overriding previously loaded MIST_HOST"
+                    )
                 self.set_cloud(mist_host)
 
             mist_apitoken = read_response["data"]["data"].get("MIST_APITOKEN", None)
             if mist_apitoken:
+                if self._apitoken:
+                    LOGGER.info(
+                        "apisession:_load_vault: overriding previously loaded MIST_APITOKEN"
+                    )
                 self.set_api_token(mist_apitoken)
         except (KeyError, TypeError, AttributeError):
             LOGGER.error("apisession:_load_vault: Failed to retrieve secret")
@@ -270,10 +294,18 @@ class APISession(APIRequest):
             try:
                 mist_host = keyring.get_password(keyring_service, "MIST_HOST")
                 if mist_host:
+                    if self._cloud_uri:
+                        LOGGER.info(
+                            "apisession:_load_keyring: overriding previously loaded MIST_HOST"
+                        )
                     LOGGER.info("apisession:_load_keyring: MIST_HOST=%s", mist_host)
                     self.set_cloud(mist_host)
                 mist_apitoken = keyring.get_password(keyring_service, "MIST_APITOKEN")
                 if mist_apitoken:
+                    if self._apitoken:
+                        LOGGER.info(
+                            "apisession:_load_keyring: overriding previously loaded MIST_APITOKEN"
+                        )
                     if isinstance(mist_apitoken, str):
                         for token in mist_apitoken.split(","):
                             token = token.strip()
@@ -285,10 +317,18 @@ class APISession(APIRequest):
                     self.set_api_token(mist_apitoken)
                 mist_user = keyring.get_password(keyring_service, "MIST_USER")
                 if mist_user:
+                    if self.email:
+                        LOGGER.info(
+                            "apisession:_load_keyring: overriding previously loaded MIST_USER"
+                        )
                     LOGGER.info("apisession:_load_keyring: MIST_USER retrieved")
                     self.set_email(mist_user)
                 mist_password = keyring.get_password(keyring_service, "MIST_PASSWORD")
                 if mist_password:
+                    if self._password:
+                        LOGGER.info(
+                            "apisession:_load_keyring: overriding previously loaded MIST_PASSWORD"
+                        )
                     LOGGER.info("apisession:_load_keyring: MIST_PASSWORD retrieved")
                     self.set_password(mist_password)
             except Exception as e:
@@ -701,6 +741,7 @@ class APISession(APIRequest):
             if resp.status_code == 200:
                 LOGGER.info("apisession:_process_login:authentication successful!")
                 CONSOLE.info("Authentication successful!")
+                self._password = None
                 self._set_authenticated(True)
             else:
                 error = resp.json().get("detail")
@@ -818,14 +859,22 @@ class APISession(APIRequest):
         elif self.email and self._password:
             if two_factor:
                 LOGGER.debug("apisession:login_with_return:login/pwd provided with 2FA")
-                if self._two_factor_authentication(two_factor):
+                error_login = self._process_login(retry=False)
+                if error_login:
+                    LOGGER.error(
+                        "apisession:login_with_return:login/pwd auth failed: %s",
+                        error_login,
+                    )
+                    return {"authenticated": False, "error": error_login}
+                if not self._two_factor_authentication(two_factor):
                     LOGGER.error(
-                        "apisession:login_with_return:login/pwd auth failed: 2FA authentication failed"
+                        "apisession:login_with_return:2FA authentication failed"
                     )
                     return {
                         "authenticated": False,
                         "error": "2FA authentication failed",
                     }
+                LOGGER.info("apisession:login_with_return:authenticated with 2FA")
             else:
                 LOGGER.debug("apisession:login_with_return:login/pwd provided w/o 2FA")
                 error_login = self._process_login(retry=False)
@@ -1044,10 +1093,8 @@ class APISession(APIRequest):
             True if authentication succeed, False otherwise
         """
         LOGGER.debug("apisession:_two_factor_authentication")
-        uri = "/api/v1/login"
+        uri = "/api/v1/login/two_factor"
         body = {
-            "email": self.email,
-            "password": self._password,
             "two_factor": two_factor,
         }
         resp = self._session.post(self._url(uri), json=body)
@@ -1102,7 +1149,19 @@ class APISession(APIRequest):
                         elif key == "tags":
                             for tag in resp.data["tags"]:
                                 self.tags.append(tag)
-                        else:
+                        elif key in [
+                            "first_name",
+                            "last_name",
+                            "email",
+                            "phone",
+                            "enable_two_factor",
+                            "two_factor_verified",
+                            "no_tracking",
+                            "oauth_google",
+                            "password_expiry",
+                            "password_modified_time",
+                            "via_sso",
+                        ]:
                             setattr(self, key, val)
                     if self._show_cli_notif:
                         print()

{mistapi-0.61.3 → mistapi-0.61.4}/src/mistapi/__version.py

@@ -1,2 +1,2 @@
-__version__ = "0.61.3"
+__version__ = "0.61.4"
 __author__ = "Thomas Munzer <tmunzer@juniper.net>"

{mistapi-0.61.3 → mistapi-0.61.4}/src/mistapi/api/v1/sites/sle.py

@@ -18,7 +18,7 @@ import deprecation
 @deprecation.deprecated(
     deprecated_in="0.59.2",
     removed_in="0.65.0",
-    current_version="0.61.3",
+    current_version="0.61.4",
     details="function replaced with getSiteSleClassifierSummaryTrend",
 )
 def getSiteSleClassifierDetails(
@@ -690,7 +690,7 @@ def listSiteSleImpactedWirelessClients(
 @deprecation.deprecated(
     deprecated_in="0.59.2",
     removed_in="0.65.0",
-    current_version="0.61.3",
+    current_version="0.61.4",
     details="function replaced with getSiteSleSummaryTrend",
 )
 def getSiteSleSummary(

{mistapi-0.61.3 → mistapi-0.61.4}/src/mistapi/websockets/__ws_client.py

@@ -69,12 +69,15 @@ class _MistWebsocket:
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         if max_reconnect_attempts < 0:
-            raise ValueError("max_reconnect_attempts must be >= 0")
+            raise ValueError("max_reconnect_attempts must be >= 0 (0 = unlimited)")
         if reconnect_backoff <= 0:
             raise ValueError("reconnect_backoff must be > 0")
+        if max_reconnect_backoff is not None and max_reconnect_backoff <= 0:
+            raise ValueError("max_reconnect_backoff must be > 0")
         if queue_maxsize < 0:
             raise ValueError("queue_maxsize must be >= 0")
 
@@ -85,6 +88,7 @@ class _MistWebsocket:
         self._auto_reconnect = auto_reconnect
         self._max_reconnect_attempts = max_reconnect_attempts
         self._reconnect_backoff = reconnect_backoff
+        self._max_reconnect_backoff = max_reconnect_backoff
         self._lock = threading.Lock()
         self._ws: websocket.WebSocketApp | None = None
         self._thread: threading.Thread | None = None
@@ -305,22 +309,32 @@ class _MistWebsocket:
                     break
 
                 self._reconnect_attempts += 1
-                if self._reconnect_attempts > self._max_reconnect_attempts:
+                if (
+                    self._max_reconnect_attempts > 0
+                    and self._reconnect_attempts > self._max_reconnect_attempts
+                ):
                     logger.warning(
                         "Max reconnect attempts (%d) reached, giving up",
                         self._max_reconnect_attempts,
                     )
                     break
 
-                delay = self._reconnect_backoff * (
-                    2 ** (self._reconnect_attempts - 1)
-                )
-                logger.info(
-                    "Reconnecting in %.1fs (attempt %d/%d)",
-                    delay,
-                    self._reconnect_attempts,
-                    self._max_reconnect_attempts,
-                )
+                delay = self._reconnect_backoff * (2 ** (self._reconnect_attempts - 1))
+                if self._max_reconnect_backoff is not None:
+                    delay = min(delay, self._max_reconnect_backoff)
+                if self._max_reconnect_attempts > 0:
+                    logger.info(
+                        "Reconnecting in %.1fs (attempt %d/%d)",
+                        delay,
+                        self._reconnect_attempts,
+                        self._max_reconnect_attempts,
+                    )
+                else:
+                    logger.info(
+                        "Reconnecting in %.1fs (attempt %d, unlimited)",
+                        delay,
+                        self._reconnect_attempts,
+                    )
                 if self._user_disconnect.wait(timeout=delay):
                     break  # disconnect() called during backoff
 

{mistapi-0.61.3 → mistapi-0.61.4}/src/mistapi/websockets/location.py

@@ -39,6 +39,8 @@ class BleAssetsEvents(_MistWebsocket):
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
         Base backoff delay in seconds. Doubles after each failed attempt.
+    max_reconnect_backoff : float | None, default None
+        Maximum backoff delay in seconds. If None, backoff grows indefinitely.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
         ``receive()`` generator. ``0`` means unbounded. When set,
@@ -80,6 +82,7 @@ class BleAssetsEvents(_MistWebsocket):
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         channels = [f"/sites/{site_id}/stats/maps/{mid}/assets" for mid in map_ids]
@@ -91,6 +94,7 @@ class BleAssetsEvents(_MistWebsocket):
             auto_reconnect=auto_reconnect,
             max_reconnect_attempts=max_reconnect_attempts,
             reconnect_backoff=reconnect_backoff,
+            max_reconnect_backoff=max_reconnect_backoff,
             queue_maxsize=queue_maxsize,
         )
 
@@ -119,6 +123,8 @@ class ConnectedClientsEvents(_MistWebsocket):
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
         Base backoff delay in seconds. Doubles after each failed attempt.
+    max_reconnect_backoff : float | None, default None
+        Maximum backoff delay in seconds. If None, backoff grows indefinitely.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
         ``receive()`` generator. ``0`` means unbounded. When set,
@@ -160,6 +166,7 @@ class ConnectedClientsEvents(_MistWebsocket):
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         channels = [f"/sites/{site_id}/stats/maps/{mid}/clients" for mid in map_ids]
@@ -171,6 +178,7 @@ class ConnectedClientsEvents(_MistWebsocket):
             auto_reconnect=auto_reconnect,
             max_reconnect_attempts=max_reconnect_attempts,
             reconnect_backoff=reconnect_backoff,
+            max_reconnect_backoff=max_reconnect_backoff,
             queue_maxsize=queue_maxsize,
         )
 
@@ -199,6 +207,8 @@ class SdkClientsEvents(_MistWebsocket):
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
         Base backoff delay in seconds. Doubles after each failed attempt.
+    max_reconnect_backoff : float | None, default None
+        Maximum backoff delay in seconds. If None, backoff grows indefinitely.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
         ``receive()`` generator. ``0`` means unbounded. When set,
@@ -240,6 +250,7 @@ class SdkClientsEvents(_MistWebsocket):
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         channels = [f"/sites/{site_id}/stats/maps/{mid}/sdkclients" for mid in map_ids]
@@ -251,6 +262,7 @@ class SdkClientsEvents(_MistWebsocket):
             auto_reconnect=auto_reconnect,
             max_reconnect_attempts=max_reconnect_attempts,
             reconnect_backoff=reconnect_backoff,
+            max_reconnect_backoff=max_reconnect_backoff,
             queue_maxsize=queue_maxsize,
         )
 
@@ -279,6 +291,8 @@ class UnconnectedClientsEvents(_MistWebsocket):
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
         Base backoff delay in seconds. Doubles after each failed attempt.
+    max_reconnect_backoff : float | None, default None
+        Maximum backoff delay in seconds. If None, backoff grows indefinitely.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
         ``receive()`` generator. ``0`` means unbounded. When set,
@@ -320,6 +334,7 @@ class UnconnectedClientsEvents(_MistWebsocket):
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         channels = [
@@ -333,6 +348,7 @@ class UnconnectedClientsEvents(_MistWebsocket):
             auto_reconnect=auto_reconnect,
             max_reconnect_attempts=max_reconnect_attempts,
             reconnect_backoff=reconnect_backoff,
+            max_reconnect_backoff=max_reconnect_backoff,
             queue_maxsize=queue_maxsize,
         )
 
@@ -361,6 +377,8 @@ class DiscoveredBleAssetsEvents(_MistWebsocket):
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
         Base backoff delay in seconds. Doubles after each failed attempt.
+    max_reconnect_backoff : float | None, default None
+        Maximum backoff delay in seconds. If None, backoff grows indefinitely.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
         ``receive()`` generator. ``0`` means unbounded. When set,
@@ -402,6 +420,7 @@ class DiscoveredBleAssetsEvents(_MistWebsocket):
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         channels = [
@@ -415,5 +434,6 @@ class DiscoveredBleAssetsEvents(_MistWebsocket):
             auto_reconnect=auto_reconnect,
             max_reconnect_attempts=max_reconnect_attempts,
             reconnect_backoff=reconnect_backoff,
+            max_reconnect_backoff=max_reconnect_backoff,
             queue_maxsize=queue_maxsize,
         )

{mistapi-0.61.3 → mistapi-0.61.4}/src/mistapi/websockets/orgs.py

@@ -37,6 +37,8 @@ class InsightsEvents(_MistWebsocket):
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
         Base backoff delay in seconds. Doubles after each failed attempt.
+    max_reconnect_backoff : float | None, default None
+        Maximum backoff delay in seconds. If None, backoff grows indefinitely.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
         ``receive()`` generator. ``0`` means unbounded. When set,
@@ -77,6 +79,7 @@ class InsightsEvents(_MistWebsocket):
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         super().__init__(
@@ -87,6 +90,7 @@ class InsightsEvents(_MistWebsocket):
             auto_reconnect=auto_reconnect,
             max_reconnect_attempts=max_reconnect_attempts,
             reconnect_backoff=reconnect_backoff,
+            max_reconnect_backoff=max_reconnect_backoff,
             queue_maxsize=queue_maxsize,
         )
 
@@ -113,6 +117,8 @@ class MxEdgesStatsEvents(_MistWebsocket):
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
         Base backoff delay in seconds. Doubles after each failed attempt.
+    max_reconnect_backoff : float | None, default None
+        Maximum backoff delay in seconds. If None, backoff grows indefinitely.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
         ``receive()`` generator. ``0`` means unbounded. When set,
@@ -153,6 +159,7 @@ class MxEdgesStatsEvents(_MistWebsocket):
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         super().__init__(
@@ -163,6 +170,7 @@ class MxEdgesStatsEvents(_MistWebsocket):
             auto_reconnect=auto_reconnect,
             max_reconnect_attempts=max_reconnect_attempts,
             reconnect_backoff=reconnect_backoff,
+            max_reconnect_backoff=max_reconnect_backoff,
             queue_maxsize=queue_maxsize,
         )
 
@@ -189,6 +197,8 @@ class MxEdgesEvents(_MistWebsocket):
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
         Base backoff delay in seconds. Doubles after each failed attempt.
+    max_reconnect_backoff : float | None, default None
+        Maximum backoff delay in seconds. If None, backoff grows indefinitely.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
         ``receive()`` generator. ``0`` means unbounded. When set,
@@ -229,6 +239,7 @@ class MxEdgesEvents(_MistWebsocket):
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         super().__init__(
@@ -239,5 +250,6 @@ class MxEdgesEvents(_MistWebsocket):
             auto_reconnect=auto_reconnect,
             max_reconnect_attempts=max_reconnect_attempts,
             reconnect_backoff=reconnect_backoff,
+            max_reconnect_backoff=max_reconnect_backoff,
             queue_maxsize=queue_maxsize,
         )

{mistapi-0.61.3 → mistapi-0.61.4}/src/mistapi/websockets/session.py

@@ -46,6 +46,8 @@ class SessionWithUrl(_MistWebsocket):
         Maximum number of reconnect attempts before giving up.
     reconnect_backoff : float, default 2.0
         Base backoff delay in seconds. Doubles after each failed attempt.
+    max_reconnect_backoff : float | None, default None
+        Maximum backoff delay in seconds. If None, backoff grows indefinitely.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
         ``receive()`` generator. ``0`` means unbounded. When set,
@@ -86,6 +88,7 @@ class SessionWithUrl(_MistWebsocket):
         auto_reconnect: bool = False,
         max_reconnect_attempts: int = 5,
         reconnect_backoff: float = 2.0,
+        max_reconnect_backoff: float | None = None,
         queue_maxsize: int = 0,
     ) -> None:
         parsed = urlparse(url)
@@ -100,6 +103,7 @@ class SessionWithUrl(_MistWebsocket):
             auto_reconnect=auto_reconnect,
             max_reconnect_attempts=max_reconnect_attempts,
             reconnect_backoff=reconnect_backoff,
+            max_reconnect_backoff=max_reconnect_backoff,
             queue_maxsize=queue_maxsize,
         )