TypeScript SDK

IntroCopy Anchor Link

The Mist API SDK provides access to the Mist API REST APIs.

Version: 2610.1.0

Date: October 1, 2026

Additional DocumentationCopy Anchor Link

• Mist Automation Guide
• Mist Location SDK
• Mist Product Updates

Helpful ResourcesCopy Anchor Link

• API Sandbox and Exercises
• Postman Collection, Runners and Webhook Samples
• Python Script Examples
• API Demo Apps
• Juniper Blog

Mist Web Browser Extension:Copy Anchor Link

• Google Chrome, Microsoft Edge and other Chromium-based browser: Chrome Web Store
• Firefox: Firefox Add-ons

InstallationCopy Anchor Link

The SDK compiles to dist/ before it can be referenced — run its build script once in the SDK folder, then add it to your project by path:

npm install <path-to-sdk>

Quick StartCopy Anchor Link

Create one client and reuse it. Configure its behaviour through ClientOptions.

import { MistApiClient, ServerEnvironment } from "mist-api";

const client = new MistApiClient({
  serverEnvironment: ServerEnvironment.MistGlobal01,
  apiToken: "YOUR_API_KEY",
  csrfToken: "YOUR_API_KEY",
});

Nothing in ClientOptions is required — new MistApiClient() compiles — and each option left out falls back to its default. serverEnvironment is spelled out above so the environment a call reaches is visible where the client is built rather than inherited silently.

From CommonJSCopy Anchor Link

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

import sdk = require("mist-api");

const client = new sdk.MistApiClient({
  serverEnvironment: sdk.ServerEnvironment.MistGlobal01,
  apiToken: "YOUR_API_KEY",
  csrfToken: "YOUR_API_KEY",
});