Version: 2509.1.5
Date: October 3, 2025
Some important API changes will be introduced. Please make sure to read the announcements
- API Sandbox and Exercises
- Postman Collection, Runners and Webhook Samples
- Python Script Examples
- API Demo Apps
- Juniper Blog
- Google Chrome, Microsoft Edge and other Chromium-based browser: Chrome Web Store
- Firefox: Firefox Add-ons
The SDK requires Go version 1.18 or above.
Resolve all the SDK dependencies, using the go get command.
The following section explains how to use the mistapi library in a new project.
- Add the following lines to your application's
go.modfile:
replace mistapi => ".\\mist-api-go_generic_lib" // local path to the SDK
require mistapi v0.0.0- Resolve the dependencies in the updated
go.modfile, using thego getcommand.
Go Testing is used as the testing framework. To run the unit tests of the SDK, navigate to the root directory of the SDK and run the following command in the terminal:
$ go testNote: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| accept | string |
Default: "application/json, application/vnd.api+json" |
| environment | Environment |
The API environment. Default: Environment.MIST_GLOBAL_01 |
| httpConfiguration | HttpConfiguration |
Configurable http client options like timeout and retries. |
| loggerConfiguration | LoggerConfiguration |
Represents the logger configurations for API calls |
| apiTokenCredentials | ApiTokenCredentials |
The Credentials Setter for Custom Header Signature |
| basicAuthCredentials | BasicAuthCredentials |
The Credentials Setter for Basic Authentication |
| csrfTokenCredentials | CsrfTokenCredentials |
The Credentials Setter for Custom Header Signature |
The API client can be initialized as follows:
package main
import (
"mistapi"
)
func main() {
client := mistapi.NewClient(
mistapi.CreateConfiguration(
mistapi.WithHttpConfiguration(
mistapi.CreateHttpConfiguration(
mistapi.WithTimeout(0),
),
),
mistapi.WithEnvironment(mistapi.MIST_GLOBAL_01),
mistapi.WithApiTokenCredentials(
mistapi.NewApiTokenCredentials("Authorization"),
),
mistapi.WithBasicAuthCredentials(
mistapi.NewBasicAuthCredentials(
"Username",
"Password",
),
),
mistapi.WithCsrfTokenCredentials(
mistapi.NewCsrfTokenCredentials("X-CSRFToken"),
),
mistapi.WithAccept("application/json, application/vnd.api+json"),
mistapi.WithLoggerConfiguration(
mistapi.WithLevel("info"),
mistapi.WithRequestConfiguration(
mistapi.WithRequestBody(true),
),
mistapi.WithResponseConfiguration(
mistapi.WithResponseHeaders(true),
),
),
),
)
}The SDK can be configured to use a different environment for making API calls. Available environments are:
| 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 | - |
This API uses the following authentication schemes.
apiToken (Custom Header Signature)basicAuth (Basic Authentication)csrfToken (Custom Header Signature)
- Admins
- Admins Login
- Admins Login-O Auth 2
- Admins Logout
- Admins Lookup
- Admins Recover Password
- 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
- Orgs Admins
- Orgs Advanced Anti Malware Profiles
- Orgs Alarms
- Orgs Alarm Templates
- Orgs Antivirus Profiles
- Orgs API Tokens
- Orgs AP Templates
- Orgs Asset Filters
- Orgs Assets
- Orgs Cert
- Orgs Clients-Marvis
- Orgs Clients-NAC
- Orgs Clients-SDK
- Orgs Clients-Wan
- Orgs Clients-Wired
- Orgs Clients-Wireless
- Orgs CRL
- Orgs Device Profiles
- Orgs Devices
- Orgs Devices-Others
- Orgs Devices-SSR
- Orgs Events
- Orgs EVPN Topologies
- Orgs Gateway Templates
- Orgs Guests
- Orgs IDP Profiles
- Orgs Integration Cradlepoint
- Orgs Integration JSE
- Orgs Integration Juniper
- Orgs Integration Sky ATP
- Orgs Integration Zscaler
- Orgs Inventory
- Orgs JSI
- Orgs Licenses
- Orgs Linked Applications
- Orgs Logs
- Orgs Maps
- Orgs Marvis
- Orgs Marvis Invites
- Orgs Mx Clusters
- Orgs Mx Edges
- Orgs Mx Tunnels
- Orgs NACCRL
- Orgs NAC Fingerprints
- Orgs NACIDP
- Orgs NAC Portals
- Orgs NAC Rules
- Orgs NAC Tags
- Orgs Networks
- Orgs Network Templates
- Orgs Premium Analytics
- Orgs Psk Portals
- Orgs Psks
- Orgs RF Templates
- Orgs SCEP
- Orgs SDK Invites
- Orgs SDK Templates
- Orgs Sec Intel Profiles
- Orgs Security Policies
- Orgs Service Policies
- Orgs Services
- Orgs Setting
- Orgs Sitegroups
- Orgs Sites
- Orgs Site Templates
- Orgs SL Es
- Orgs SSO
- Orgs SSO Roles
- Orgs Stats
- Orgs Stats-Assets
- Orgs Stats-BGP Peers
- Orgs Stats-Devices
- Orgs Stats-Mx Edges
- Orgs Stats-Other Devices
- Orgs Stats-Ports
- Orgs Stats-Sites
- Orgs Stats-Tunnels
- Orgs Stats-VPN Peers
- Orgs Tickets
- Orgs UI Settings
- Orgs User MA Cs
- Orgs Vars
- Orgs VP Ns
- Orgs Webhooks
- Orgs Wlans
- Orgs WLAN Templates
- Orgs Wx Rules
- Orgs Wx Tags
- Orgs Wx Tunnels
- Samples Webhooks
- Self Account
- Self Alarms
- Self API Token
- Self Audit Logs
- Self MFA
- Self O Auth 2
- Sites
- Sites Advanced Anti Malware Profiles
- Sites Alarms
- Sites Anomaly
- Sites Antivirus Profiles
- Sites Applications
- Sites AP Templates
- Sites Asset Filters
- Sites Assets
- Sites Beacons
- Sites Clients-NAC
- Sites Clients-Wan
- Sites Clients-Wired
- Sites Clients-Wireless
- Sites Device Profiles
- Sites Devices
- Sites Devices-Others
- Sites Devices-WAN Cluster
- Sites Devices-Wired
- Sites Devices-Wired-Virtual Chassis
- Sites Devices-Wireless
- Sites Events
- Sites EVPN Topologies
- Sites Gateway Templates
- Sites Guests
- Sites IDP Profiles
- Sites Insights
- Sites JSE
- Sites Licenses
- Sites Location
- Sites Maps
- Sites Maps-Auto-Placement
- Sites Maps-Auto-Zone
- Sites Mx Edges
- Sites Networks
- Sites Network Templates
- Sites Psks
- Sites Rfdiags
- Sites RF Templates
- Sites Rogues
- Sites RRM
- Sites RSSI Zones
- Sites Sec Intel Profiles
- Sites Service Policies
- Sites Services
- Sites Setting
- Sites Site Templates
- Sites Skyatp
- Sites SL Es
- Sites Spectrum Analysis
- Sites Stats
- Sites Stats-Apps
- Sites Stats-Assets
- Sites Stats-Beacons
- Sites Stats-BGP Peers
- Sites Stats-Calls
- Sites Stats-Clients SDK
- Sites Stats-Clients Wireless
- Sites Stats-Devices
- Sites Stats-Discovered Switches
- Sites Stats-Mx Edges
- Sites Stats-Ports
- Sites Stats-Wx Rules
- Sites Stats-Zones
- Sites Synthetic Tests
- Sites UI Settings
- Sitesv Beacons
- Sites VP Ns
- Sites WAN Usages
- Sites Webhooks
- Sites Wlans
- Sites Wx Rules
- Sites Wx Tags
- Sites Wx Tunnels
- Sites Zones
- Utilities Common
- Utilities LAN
- Utilities Location
- Utilities Mx Edge
- Utilities PCA Ps
- Utilities Upgrade
- Utilities WAN
- Utilities Wi-Fi