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:

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:

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

This release hardens the WebSocket client with improved thread-safety, bounded message queues, and better error handling.

1. NEW FEATURES

Bounded Message Queue (`queue_maxsize`)

The _MistWebsocket client now supports a queue_maxsize parameter to limit the internal message buffer size. When set, incoming messages are dropped with a warning when the queue is full, preventing unbounded memory growth on high-frequency streams.

ws = mistapi.websockets.sites.DeviceStatsEvents(
    apisession,
    site_ids=["<site_id>"],
    queue_maxsize=1000  # Limit buffer to 1000 messages
)

2. IMPROVEMENTS

Thread-Safety Enhancements

Added threading.Lock() to protect shared state during concurrent access
Added _finished event for cleaner lifecycle management and proper shutdown signaling

Error Handling Hardening

User-provided callbacks (on_open, on_message, on_error, on_close) are now wrapped in try/except blocks to prevent exceptions from crashing the WebSocket thread
Added warning when cloud_uri does not start with "api." (WebSocket URL may be incorrect)

Security: Header Redaction

Added _HeaderRedactFilter to automatically redact Authorization and Cookie headers from websocket-client debug logs

3. API CHANGES

Insights API

Added optional port_id query parameter to the following functions for port-level filtering:

getSiteInsightMetricsForDevice()
getSiteInsightMetricsForGateway()
getSiteInsightMetricsForMxEdge()
getSiteInsightMetricsForSwitch()

Version 0.61.2 (March 2026)

Released: March 17, 2026

This release adds automatic reconnection support for WebSocket streams, updates the OpenAPI specification, and includes minor bug fixes.

1. NEW FEATURES

WebSocket Auto-Reconnect

_MistWebsocket now supports automatic reconnection with configurable parameters:

auto_reconnect — Enable/disable auto-reconnect (default: False)
max_reconnect_attempts — Maximum reconnect attempts before giving up (default: 5)
reconnect_backoff — Base backoff delay in seconds, with exponential increase (default: 2.0)

When enabled, the WebSocket automatically reconnects on transient failures using exponential backoff. User-initiated disconnect() calls are respected during reconnection attempts.

ws = mistapi.websockets.sites.DeviceStatsEvents(
    apisession,
    site_ids=["<site_id>"],
    auto_reconnect=True,
    max_reconnect_attempts=5,
    reconnect_backoff=2.0
)
ws.connect(run_in_background=True)

2. API CHANGES (OpenAPI 2602.1.7)

Updated to mist_openapi spec version 2602.1.7.

Insights API

getSiteInsightMetrics() — Now uses metrics as a query parameter instead of a path parameter
getSiteInsightMetricsForAP() — New function to retrieve insight metrics for a specific AP
getSiteInsightMetricsForClient() — Changed metric path parameter to metrics query parameter
getSiteInsightMetricsForGateway() — Changed metric path parameter to metrics query parameter

Stats API

getOrgStats() — Removed start, end, duration, limit, page query parameters
listOrgSiteStats() — Removed start, end, duration query parameters

3. BUG FIXES

Fixed ShellSession.recv() to gracefully handle socket timeout reset when the connection is already closed
Fixed thread-safety (TOCTOU) race conditions in ShellSession by capturing WebSocket reference in local variables across disconnect(), connected, send(), recv(), and resize() methods
Fixed thread-safety race condition in _MistWebsocket.disconnect() with local variable capture

Version 0.61.1 (March 2026)

Released: March 15, 2026

This release improves async support with a new arun() helper, makes the Device Utilities module fully non-blocking, adds VT100 terminal emulation for screen-based commands, and introduces interactive SSH shell access for EX/SRX devices. (PR #16)

1. NEW FEATURES

`mistapi.arun()` — Async Helper

New helper function to run any sync mistapi function without blocking the event loop. Wraps the function call in asyncio.to_thread() so blocking HTTP requests run in a thread pool.

import asyncio
import mistapi
from mistapi.api.v1.sites import devices

async def main():
    session = mistapi.APISession(env_file="~/.mist_env")
    session.login()

    # Run sync API call without blocking the event loop
    response = await mistapi.arun(devices.listSiteDevices, session, site_id)
    print(response.data)

asyncio.run(main())

Interactive SSH Shell (`device_utils.ex` / `device_utils.srx`)

New interactiveShell() and createShellSession() functions for SSH-over-WebSocket access to EX and SRX devices.

interactiveShell() — takes over the terminal for human SSH access (uses sshkeyboard)
createShellSession() — returns a ShellSession object for programmatic send/recv
ShellSession — bidirectional WebSocket session with send(), recv(), resize(), context manager support

from mistapi.device_utils import ex

# Interactive (human at the keyboard)
ex.interactiveShell(apisession, site_id, device_id)

# Programmatic
with ex.createShellSession(apisession, site_id, device_id) as session:
    session.send_text("show version\r\n")
    import time; time.sleep(3)
    while (data := session.recv(timeout=0.5)):
        print(data.decode("utf-8", errors="replace"), end="")

`topCommand` (`device_utils.ex` / `device_utils.srx`)

New topCommand() function to stream top output from EX and SRX devices. Uses VT100 screen-buffer rendering for proper in-place display.

VT100 Terminal Emulation

Added ANSI escape stripping and a minimal VT100 screen-buffer renderer for device command output. Stream-mode commands (ping, traceroute) have ANSI codes stripped automatically. Screen-mode commands (top, monitor interface) are rendered through a virtual terminal buffer.

2. IMPROVEMENTS

Non-Blocking Device Utilities

All mistapi.device_utils functions now return immediately. The HTTP trigger and WebSocket streaming run in background threads, allowing your code to continue executing while data is collected.

UtilResponse Object:

Method/Property	Description
`.ws_data`	List of processed messages
`.done`	`True` if data collection is complete
`.wait(timeout)`	Block until complete, returns self
`.receive()`	Generator yielding messages as they arrive
`.disconnect()`	Stop the WebSocket connection early
`await response`	Async-friendly wait (non-blocking event loop)

Example Usage:

from mistapi.device_utils import ex

# Non-blocking - returns immediately, data collected in background
response = ex.ping(apisession, site_id, device_id, host="8.8.8.8")
do_other_work()  # Can do other things while waiting
response.wait()  # Block when ready to collect results
print(response.ws_data)

# Generator style - process messages as they arrive
for msg in response.receive():
    print(msg)

# Async-friendly - doesn't block the event loop
await response

Binary WebSocket Frame Support

_MistWebsocket._handle_message() now handles binary frames (strips null bytes, decodes UTF-8 with replacement characters).

Trigger-Only Commands Run Synchronously

Fire-and-forget device commands (e.g., clearMacTable, clearBpduError, clearHitCount) that don't require a WebSocket stream now run the API trigger synchronously, ensuring trigger_api_response is immediately available on the returned UtilResponse.

3. BUG FIXES

Fixed double-space typo in API token privilege mismatch error message
Fixed first_message_timeout timer stop to check timer is active before stopping

4. DEPENDENCIES

Added sshkeyboard>=2.3.1 (for interactiveShell())

Version 0.61.0 (March 2026)

Released: March 13, 2026

MAJOR RELEASE with extensive new features, code quality improvements, security enhancements, and performance optimizations. This release adds real-time WebSocket streaming, comprehensive device diagnostic utilities, extensive test coverage, and significant API improvements.

1. NEW FEATURES

1.1 WebSocket Streaming Module (`mistapi.websockets`)

Complete real-time event streaming support with flexible consumption patterns:

Available Channels:

Organization Channels

Class	Description
`mistapi.websockets.orgs.InsightsEvents`	Real-time insights events for an organization
`mistapi.websockets.orgs.MxEdgesStatsEvents`	Real-time MX edges stats for an organization
`mistapi.websockets.orgs.MxEdgesEvents`	Real-time MX edges events for an organization

Site Channels

Class	Description
`mistapi.websockets.sites.ClientsStatsEvents`	Real-time clients stats for a site
`mistapi.websockets.sites.DeviceCmdEvents`	Real-time device command events for a site
`mistapi.websockets.sites.DeviceStatsEvents`	Real-time device stats for a site
`mistapi.websockets.sites.DeviceEvents`	Real-time device events for a site
`mistapi.websockets.sites.MxEdgesEvents`	Real-time MX edges events for a site
`mistapi.websockets.sites.MxEdgesStatsEvents`	Real-time MX edges stats for a site
`mistapi.websockets.sites.PcapEvents`	Real-time PCAP events for a site

Location Channels

Class	Description
`mistapi.websockets.location.BleAssetsEvents`	Real-time BLE assets location events
`mistapi.websockets.location.ConnectedClientsEvents`	Real-time connected clients location events
`mistapi.websockets.location.SdkClientsEvents`	Real-time SDK clients location events
`mistapi.websockets.location.UnconnectedClientsEvents`	Real-time unconnected clients location events
`mistapi.websockets.location.DiscoveredBleAssetsEvents`	Real-time discovered BLE assets location events

Features:

Callback-based message handling
Generator-style iteration
Context manager support
Automatic reconnection with configurable ping intervals
Non-blocking background threads
Type-safe API with full parameter validation

Example Usage:

ws = mistapi.websockets.sites.DeviceStatsEvents(apisession, site_ids=["<site_id>"])
ws.connect(run_in_background=True)

for msg in ws.receive():        # blocks, yields each message as a dict
    print(msg)
    if some_condition:
        ws.disconnect()         # stops the generator cleanly

1.2 Device Utilities Module (`mistapi.device_utils`)

mistapi.device_utils provides high-level utilities for running diagnostic commands on Mist-managed devices. Each function triggers a REST API call and streams the results back via WebSocket. The library handles the connection plumbing — you just call the function and get back a UtilResponse object.

Device-Specific Modules (Recommended):

Module	Device Type	Functions
`device_utils.ap`	Mist Access Points	`ping`, `traceroute`, `retrieveArpTable`
`device_utils.ex`	Juniper EX Switches	`ping`, `monitorTraffic`, `retrieveArpTable`, `retrieveBgpSummary`, `retrieveDhcpLeases`, `releaseDhcpLeases`, `retrieveMacTable`, `clearMacTable`, `clearLearnedMac`, `clearBpduError`, `clearDot1xSessions`, `clearHitCount`, `bouncePort`, `cableTest`
`device_utils.srx`	Juniper SRX Firewalls	`ping`, `monitorTraffic`, `retrieveArpTable`, `retrieveBgpSummary`, `retrieveDhcpLeases`, `releaseDhcpLeases`, `showDatabase`, `showNeighbors`, `showInterfaces`, `bouncePort`, `retrieveRoutes`
`device_utils.ssr`	Juniper SSR Routers	`ping`, `retrieveArpTable`, `retrieveBgpSummary`, `retrieveDhcpLeases`, `releaseDhcpLeases`, `showDatabase`, `showNeighbors`, `showInterfaces`, `bouncePort`, `retrieveRoutes`, `showServicePath`

Example Usage:

from mistapi.device_utils import ap, ex

# Ping from an AP
result = ap.ping(apisession, site_id, device_id, host="8.8.8.8")
print(result.ws_data)

# Retrieve ARP table from a switch
result = ex.retrieveArpTable(apisession, site_id, device_id)
print(result.ws_data)

# With real-time callback
def handle(msg):
    print("got:", msg)

result = ex.cableTest(apisession, site_id, device_id, port_id="ge-0/0/0", on_message=handle)

1.3 New API Endpoints

MapStacks API (mistapi.api.v1.sites.mapstacks):

listSiteMapStacks(): List map stacks with filtering
createSiteMapStack(): Create new map stack

Enhanced Query Parameters:

Additional filtering options across alarms, clients, and devices endpoints
Improved parameter handling in JSI, NAC clients, and WAN clients APIs

2. SECURITY IMPROVEMENTS

HashiCorp Vault SSL Verification

Now properly verifies SSL certificates when connecting to Vault
Made vault configuration attributes private (_vault_url, _vault_path, etc.)
Improved cleanup of vault credentials after loading

3. PERFORMANCE IMPROVEMENTS

Lazy Module Loading

Implemented lazy loading for api and cli subpackages
Reduces initial import time by deferring heavy module imports until accessed
Uses __getattr__ for transparent lazy loading

4. CODE QUALITY IMPROVEMENTS

HTTP Request Error Handling

Consolidated duplicate error handling logic into _request_with_retry() method
Extracts HTTP operations into inner functions for cleaner code
Reduces code duplication by ~55 lines across GET/POST/PUT/DELETE/POST_FILE methods
Centralizes 429 rate limit handling and retry logic

Session Management

Added _new_session() helper method for consistent session initialization
Improves code reusability when creating new HTTP sessions

API Token Management

Added validate parameter to set_api_token() method
Allows skipping token validation when needed (default: True)
Useful for faster initialization when tokens are known to be valid

Logging Improvements

Fixed logging sanitization to use getMessage() instead of direct msg access
Clear record.args after sanitization to prevent re-formatting issues
Improved logging format consistency using %-style formatting

6. DEPENDENCIES

New Dependencies

Added websocket-client>=1.8.0 for WebSocket streaming support

Version 0.60.4 (March 2026)

Released: March 3, 2026

This release updates the OpenAPI submodule to version 2602.1.4, adds the new Map Stacks API, and includes various API improvements and bug fixes.

1. NEW FEATURES

Site Map Stacks API

Added new sites/mapstacks.py module with listSiteMapStacks() and createSiteMapStack() functions

2. CHANGES

API Function Updates

Updated searchOrgInventory() in orgs/inventory.py: Added model parameter for device model filtering
Updated searchOrgJsiAssetsAndContracts() in orgs/jsi.py:
- Replaced eol_duration and eos_duration with date-based filters: eol_after, eol_before, eos_after, eos_before
- Added version_eos_after and version_eos_before for software version end-of-support filtering
- Added sirt_id and pbn_id for security advisory filtering
Updated searchOrgAlarms() and searchSiteAlarms() documentation with Marvis alarm group details

3. BUG FIXES

Fixed APIResponse.data type annotation to support both dict and list responses
Fixed _check_next() method to properly handle list responses in pagination

Breaking Changes

searchOrgJsiAssetsAndContracts(): Parameters eol_duration and eos_duration have been replaced with eol_after, eol_before, eos_after, and eos_before

Version 0.60.3 (February 2026)

Released: February 21, 2026

This release add a missing query parameter to the searchOrgWanClients() function.

1. CHANGES

API Function Updates

Updated searchOrgWanClients() and related functions in orgs/wan_clients.py.

Version 0.60.1 (February 2026)

Released: February 21, 2026

This release includes function updates and bug fixes in the self/logs.py and sites/sle.py modules.

1. CHANGES

API Function Updates

Updated listSelfAuditLogs() and related functions in self/logs.py.
Updated deprecated and new SLE classifier functions in sites/sle.py.

2. BUG FIXES

Minor bug fixes and improvements in API modules.

Breaking Changes

No breaking changes in this release.

Version 0.60.0 (February 2026)

Released: February 19, 2026

This release updates the OpenAPI submodule, adds new org/site endpoints, fixes a couple of API paths, and updates the API definitions to match the latest OpenAPI specification (2602.1.1).

1. NEW FEATURES

Org AOS Registration

Added getOrgAosRegisterCmd() for AOS registration command retrieval

JSI PBN/SIRT Endpoints

Added countOrgJsiPbn() and searchOrgJsiPbn()
Added countOrgJsiSirt() and searchOrgJsiSirt()

Site Assets Image Management

Added deleteSiteAssetImage()
Added attachSiteAssetImageFile() for multipart image uploads

Site Maps Auto-Geofence

Added startSiteMapsAutoGeofence() (site-level)
Added startSiteMapAutoGeofence() (map-level)

MxEdge VM Parameters

Added getOrgMxEdgeVmParams()

2. API UPDATES

MxEdge Image Upload and Version Info

addOrgMxEdgeImage() replaced with addOrgMxEdgeImageFile() using multipart upload
Updated MxEdge versions endpoint to /mxedges/versions

NAC Client Search Enhancements

Added cert_expiry_duration to searchOrgNacClients()

Ports Search Filters

Updated org/site ports search filters to align with OpenAPI parameters
Added LTE identifiers and device-type filters where applicable
Removed unsupported stats-only filters from search endpoints

3. BUG FIXES

Sites Device Image Paths

Fixed image API paths to include /image/{image_number}

Breaking Changes

Potential Breaking Change: addOrgMxEdgeImage() replaced by addOrgMxEdgeImageFile() and now uses multipart uploads. Update any callers to pass file/json parameters instead of a JSON body.

Version 0.59.5 (January 2026)

Released: January 29, 2026

This release improves error handling by replacing sys.exit() calls with proper exceptions, fixes pagination issues, and updates the API definitions to match the latest OpenAPI specification (2511.1.14).

1. BUG FIXES

Pagination Fix

Fixed pagination issue when page parameter is not already present in the URL
Added logic to properly append page parameter with correct separator (? or &)
Improved APIResponse._check_next() to handle URLs without existing pagination parameters

Error Handling Improvements

Replaced sys.exit() calls with proper exception raising in API validation and authentication methods
_get_api_token_data(): Now raises ConnectionError instead of calling sys.exit() for proxy and connection errors
_get_api_token_data(): Now raises ValueError instead of calling sys.exit(2) for invalid API tokens (401 status)
_process_login(): Now raises ConnectionError instead of calling sys.exit() for proxy and connection errors
_getself(): Now raises ConnectionError for proxy errors and ValueError when authentication fails and user declines to retry

2. API UPDATES

OpenAPI Specification Update

Updated to latest Mist OpenAPI specification
Enhanced alarm search endpoints with additional filtering parameters:
- searchOrgAlarms(): Added group, severity, ack_admin_name, and acked parameters
- searchSiteAlarms(): Enhanced parameter support
Updated parameter types and documentation across multiple endpoints

Breaking Changes

Potential Breaking Change: Code that previously relied on sys.exit() behavior during authentication failures will now receive exceptions instead. This is a more correct behavior for library code.

ConnectionError is raised for proxy and connection errors
ValueError is raised for invalid API tokens or failed authentication

Version 0.59.4 (January 2026)

Released: January 28, 2026

This release removes default values from optional parameters across all API functions, improving code clarity and consistency.

1. CHANGES

API Parameter Defaults Removed

Removed default values from optional parameters across all API endpoint functions
All optional parameters now default to None instead of using OpenAPI-specified defaults
Default values are handled directly by the Mist Cloud API when parameters are omitted
Eliminates redundancy and potential inconsistencies between client and server defaults
Improves consistency and makes it clearer which parameters are explicitly set by the caller
Affects 116 files across the codebase

Breaking Changes

Breaking Change: Functions that previously had default values specified from the OpenAPI spec now default to None. However, this should not affect behavior as the Mist Cloud API applies the same default values server-side when parameters are omitted.

If you were explicitly relying on seeing the default values in the Python function signature, you will now need to refer to the Mist API documentation for default values.

Example:

# Before 0.59.4 (if API spec had duration="1d" as default)
searchOrgAlarms(session, org_id)  # duration defaulted to "1d" in Python

# After 0.59.4
searchOrgAlarms(session, org_id)  # duration=None sent, Mist Cloud applies "1d" default
searchOrgAlarms(session, org_id, duration="1d")  # Explicit is also fine

Note: The actual API behavior remains unchanged - the Mist Cloud handles default values consistently.

Version 0.59.3 (December 2024)

Released: December 26, 2024

This release adds security enhancements for log sanitization and includes dependency updates.

1. NEW FEATURES

Log Sanitization

Added LogSanitizer filter to automatically redact sensitive fields from log messages
Supports filtering of passwords, API tokens, keys, secrets, and other sensitive data
Can be applied to both standard Python logging and the custom Console logger

Usage Example

import logging
from mistapi.__logger import LogSanitizer

LOG_FILE = "./log.txt"
logging.basicConfig(filename=LOG_FILE, filemode="w")
LOGGER = logging.getLogger(__name__)
LOGGER.setLevel(logging.DEBUG)
LOGGER.addFilter(LogSanitizer())

LOGGER.debug(var_with_sensitive_data)

2. DEPENDENCIES

Added

keyring - Secure system keyring access for password storage
- macOS Keychain support
- Windows Credential Locker support
- Freedesktop Secret Service support (GNOME, KDE)

Updated

Various dependency updates for security and compatibility

Breaking Changes

None. This is a backwards-compatible release.

Security Improvements

This release significantly improves security by automatically sanitizing sensitive information in logs, including:

API tokens and keys
Passwords and passphrases
OAuth secrets
PSK/mesh keys
Authentication credentials
And 20+ other sensitive field types

Version 0.59.2 (December 2024)

Released: December 2024

This is a maintenance release that adds support for deprecated SLE endpoints and reorganizes project structure.

1. FUNCTIONS ADDED

src/mistapi/api/v1/sites/sle.py

getSiteSleSummary(mist_session, site_id, scope, scope_id, metric, start, end, duration) - Get SLE metric summary (marked as deprecated in Mist API, replaced by getSiteSleSummaryTrend)
getSiteSleSummaryTrend(mist_session, site_id, scope, scope_id, metric, start, end, duration) - Get SLE metric summary trend (replacement for deprecated endpoint)
getSiteSleClassifierDetails(mist_session, site_id, scope, scope_id, metric, classifier, start, end, duration) - Get SLE classifier details (marked as deprecated in Mist API, replaced by getSiteSleClassifierSummaryTrend)
getSiteSleClassifierSummaryTrend(mist_session, site_id, scope, scope_id, metric, classifier, start, end, duration) - Get SLE classifier summary trend (replacement for deprecated endpoint)

2. FUNCTIONS DEPRECATED

src/mistapi/api/v1/sites/sle.py

getSiteSleSummary - Deprecated in version 0.59.2, will be removed in 0.65.0 (replaced by getSiteSleSummaryTrend)
getSiteSleClassifierDetails - Deprecated in version 0.59.2, will be removed in 0.65.0 (replaced by getSiteSleClassifierSummaryTrend)

Note: These functions are marked with @deprecation.deprecated decorator and will show deprecation warnings when used.

Breaking Changes

None. All deprecated functions remain available with deprecation warnings.

Migration Guide

If you're using the deprecated SLE functions:

Before (deprecated):

# This will show deprecation warning
response = mistapi.api.v1.sites.sle.getSiteSleSummary(
    mist_session, site_id, scope, scope_id, metric
)

After (recommended):

# Use the new trend endpoint
response = mistapi.api.v1.sites.sle.getSiteSleSummaryTrend(
    mist_session, site_id, scope, scope_id, metric
)

Both functions will continue to work until version 0.65.0.

Resources

Full API Documentation: Mist API Documentation
GitHub Repository: mistapi_python
PyPI Package: mistapi
Issue Tracker: GitHub Issues

Version 0.59.1 (December 2024)

Released: December 2024

This release introduces significant enhancements to the Mist API Python SDK, including new endpoints, improved pagination support, and updated API specifications.

1. FUNCTIONS ADDED

src/mistapi/api/v1/orgs/ssr.py

exportOrgSsrIdTokens(mist_session, org_id, body) - Export SSR identity tokens

src/mistapi/api/v1/orgs/stats.py

countOrgOspfStats(mist_session, org_id, distinct, start, end, limit, sort, search_after) - Count OSPF stats at org level
searchOrgOspfStats(mist_session, org_id, site_id, mac, peer_ip, port_id, state, vrf_name, start, end, duration, limit, sort, search_after) - Search OSPF peer stats

src/mistapi/api/v1/sites/devices.py

setSiteDevicesGbpTag(mist_session, site_id, body) - Set Group-Based Policy tags for devices

src/mistapi/api/v1/sites/insights.py

getSiteInsightMetricsForGateway(mist_session, site_id, metric, device_id, start, end, duration, interval, limit, page) - Get insight metrics for gateways
getSiteInsightMetricsForMxEdge(mist_session, site_id, metric, mxedge_id, start, end, duration, interval, limit, page) - Get insight metrics for MxEdges
getSiteInsightMetricsForSwitch(mist_session, site_id, metric, device_id, start, end, duration, interval, limit, page) - Get insight metrics for switches

src/mistapi/api/v1/sites/stats.py

countSiteOspfStats(mist_session, site_id, distinct, start, end, limit, sort, search_after) - Count OSPF stats at site level
searchSiteOspfStats(mist_session, site_id, mac, peer_ip, port_id, state, vrf_name, start, end, duration, limit, sort, search_after) - Search OSPF peer stats for site

3. FUNCTIONS DEPRECATED

getOrg128TRegistrationCommands in src/mistapi/api/v1/orgs/ssr.py (replaced by getOrgSsrRegistrationCommands)

4. PARAMETER CHANGES

A. Added `search_after` parameter (for improved pagination)

MSPs Module:

src/mistapi/api/v1/msps/orgs.py
- searchMspOrgs: Added start, end, search_after

Orgs Module - Alarms:

src/mistapi/api/v1/orgs/alarms.py
- searchOrgAlarms: Added search_after

Orgs Module - Clients:

src/mistapi/api/v1/orgs/clients.py
- searchOrgWirelessClientEvents: Added search_after
- searchOrgWirelessClients: Added search_after
- searchOrgWirelessClientSessions: Added search_after

Orgs Module - Devices:

src/mistapi/api/v1/orgs/devices.py
- searchOrgDeviceEvents: Added search_after
- searchOrgDevices: Added search_after

Orgs Module - Events:

src/mistapi/api/v1/orgs/events.py
- searchOrgEvents: Added search_after
- searchOrgSystemEvents: Added search_after

Orgs Module - MxEdges:

src/mistapi/api/v1/orgs/mxedges.py
- searchOrgMistEdgeEvents: Added search_after

Orgs Module - NAC Clients:

src/mistapi/api/v1/orgs/nac_clients.py
- searchOrgNacClientEvents: Added search_after

Orgs Module - Other Devices:

src/mistapi/api/v1/orgs/otherdevices.py
- searchOrgOtherDeviceEvents: Added search_after

Orgs Module - Sites:

src/mistapi/api/v1/orgs/sites.py
- searchOrgSites: Added search_after

Orgs Module - Stats:

src/mistapi/api/v1/orgs/stats.py
- searchOrgAssets: Added search_after
- searchOrgBgpStats: Added search_after
- searchOrgSwOrGwPorts: Added search_after
- searchOrgTunnelsStats: Added search_after
- searchOrgPeerPathStats: Added search_after

Orgs Module - WAN Clients:

src/mistapi/api/v1/orgs/wan_clients.py
- searchOrgWanClientEvents: Added search_after

Orgs Module - Webhooks:

src/mistapi/api/v1/orgs/webhooks.py
- searchOrgWebhooksDeliveries: Added search_after

Orgs Module - Wired Clients:

src/mistapi/api/v1/orgs/wired_clients.py
- searchOrgWiredClients: Added search_after

Sites Module - Alarms:

src/mistapi/api/v1/sites/alarms.py
- searchSiteAlarms: Added search_after

Sites Module - Clients:

src/mistapi/api/v1/sites/clients.py
- searchSiteWirelessClientEvents: Added search_after
- searchSiteWirelessClients: Added search_after
- searchSiteWirelessClientSessions: Added search_after

Sites Module - Devices:

src/mistapi/api/v1/sites/devices.py
- searchSiteDeviceConfigHistory: Added search_after
- searchSiteDeviceEvents: Added search_after
- searchSiteDeviceLastConfigs: Added search_after
- searchSiteDevices: Added search_after

Sites Module - Events:

src/mistapi/api/v1/sites/events.py
- searchSiteSystemEvents: Added search_after

Sites Module - Guests:

src/mistapi/api/v1/sites/guests.py
- searchSiteGuestAuthorization: Added search_after

Sites Module - Insights:

src/mistapi/api/v1/sites/insights.py
- searchOrgClientFingerprints: Added search_after

Sites Module - Stats:

src/mistapi/api/v1/sites/stats.py
- searchSiteAssets: Added search_after
- searchSiteBgpStats: Added search_after
- searchSiteCalls: Added search_after
- searchSiteDiscoveredSwitchesMetrics: Added search_after

B. Other Parameter Updates

Sites Module - Insights:

src/mistapi/api/v1/sites/insights.py
- searchOrgClientFingerprints: Parameter client_type now accepts 'vty' in addition to 'wireless' and 'wired'

Resources

Full API Documentation: Mist API Documentation
GitHub Repository: mistapi_python
PyPI Package: mistapi
Issue Tracker: GitHub Issues

Previous Releases

Version 0.58.0

Previous stable release. See commit history for details.

Author: Thomas Munzer tmunzer@juniper.net
License: MIT License
Python Compatibility: Python 3.10+

FilesExpand file tree

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

CHANGELOG

Version 0.61.4 (April 2026)

1. NEW FEATURES

Capped Reconnect Backoff (max_reconnect_backoff)

Unlimited Reconnect Attempts

2. IMPROVEMENTS

Credential Override Logging

Security: Password Cleared After Login

User Attribute Handling

Version 0.61.3 (March 2026)

1. NEW FEATURES

Bounded Message Queue (queue_maxsize)

2. IMPROVEMENTS

Thread-Safety Enhancements

Error Handling Hardening

Security: Header Redaction

3. API CHANGES

Insights API

Version 0.61.2 (March 2026)

1. NEW FEATURES

WebSocket Auto-Reconnect

2. API CHANGES (OpenAPI 2602.1.7)

Insights API

Stats API

3. BUG FIXES

Version 0.61.1 (March 2026)

1. NEW FEATURES

mistapi.arun() — Async Helper

Interactive SSH Shell (device_utils.ex / device_utils.srx)

topCommand (device_utils.ex / device_utils.srx)

VT100 Terminal Emulation

2. IMPROVEMENTS

Non-Blocking Device Utilities

Binary WebSocket Frame Support

Trigger-Only Commands Run Synchronously

3. BUG FIXES

4. DEPENDENCIES

Version 0.61.0 (March 2026)

1. NEW FEATURES

1.1 WebSocket Streaming Module (mistapi.websockets)

1.2 Device Utilities Module (mistapi.device_utils)

1.3 New API Endpoints

2. SECURITY IMPROVEMENTS

HashiCorp Vault SSL Verification

3. PERFORMANCE IMPROVEMENTS

Lazy Module Loading

4. CODE QUALITY IMPROVEMENTS

HTTP Request Error Handling

Session Management

API Token Management

Logging Improvements

6. DEPENDENCIES

New Dependencies

Version 0.60.4 (March 2026)

1. NEW FEATURES

Site Map Stacks API

2. CHANGES

API Function Updates

3. BUG FIXES

Breaking Changes

Version 0.60.3 (February 2026)

1. CHANGES

API Function Updates

Version 0.60.1 (February 2026)

1. CHANGES

API Function Updates

2. BUG FIXES

Breaking Changes

Version 0.60.0 (February 2026)

1. NEW FEATURES

Org AOS Registration

JSI PBN/SIRT Endpoints

Site Assets Image Management

Site Maps Auto-Geofence

Capped Reconnect Backoff (`max_reconnect_backoff`)

Bounded Message Queue (`queue_maxsize`)

`mistapi.arun()` — Async Helper

Interactive SSH Shell (`device_utils.ex` / `device_utils.srx`)

`topCommand` (`device_utils.ex` / `device_utils.srx`)

1.1 WebSocket Streaming Module (`mistapi.websockets`)

1.2 Device Utilities Module (`mistapi.device_utils`)

A. Added `search_after` parameter (for improved pagination)