Juniper Mist Cloud Operations · Topic 1 of 3

Juniper Mist RESTful API

Learn the Juniper Mist RESTful API: the 100% API design, regional hosts, HTTP methods, organization and user API tokens, authentication and rate limits.

  • 5 min
In a nutshell
  • 100% API architecture: everything in the portal is available through the API.
  • URL pattern https://{api-host}/api/v1/...; the host must match the cloud region.
  • GET reads, POST creates, PUT updates (arrays replaced), DELETE removes; JSON only.

What it is

Juniper Mist is built on a 100% API architecture. Every feature you see in the portal is backed by the same RESTful API, so anything you can do in the portal you can also automate: create sites, push WLANs, read client statistics or claim devices.

The REST API is a pull model. Your script or application sends an HTTPS request, Mist sends back JSON, and the conversation ends. It is the right tool for configuration and automation.

Scriptwith API tokenHTTPS requestMist REST APIregional hostJSON responseScript

How it works

URLs and regions

Every call uses the same pattern:

https://{api-host}/api/v1/...

The version is v1 for all APIs. The host must match the cloud region where your organization lives.

RegionAPI host
Global 01api.mist.com
Global 02api.gc1.mist.com
EMEA 01api.eu.mist.com
APAC 01api.ac5.mist.com

The full list of regions is on the API Endpoints and Global Regions page of the documentation.

Scopes and objects

A request names a scope, a scope ID, and then the object. Scopes include msp, org, site, self, register, installer and const. For example, /api/v1/orgs/:org_id/sites works on the sites of one organization, while /api/v1/self returns information about the caller.

For large deployments, Juniper recommends making calls at the organization level instead of looping through every site, which saves calls against the rate limit.

Methods

MethodWhat it does
GETLists objects, or reads one object when an ID is given
POSTCreates an object
PUTUpdates an object; simple values not in the payload keep their values, but arrays and objects are replaced completely
DELETERemoves the object

Payloads and responses are always JSON (application/json).

Watch out

A PUT replaces arrays and nested objects in full. Sending a PUT with only one new WLAN in a list can remove the others, so read the object first and send back the complete array.

Authentication

MethodNotes
API tokenThe usual choice for scripts; treat it like a password
HTTP loginUsername and password, like a portal login, and can use two factor authentication
OAuth2The account must be linked to an OAuth provider and needs browser access

A token is sent in the HTTP Authorization header with the keyword Token in front of the key, for example Authorization: Token {apitoken}. Mist has deprecated Basic Authentication, effective September 2026, so integrations should use tokens.

API tokens

Organization tokenUser token
Belongs toThe organizationOne user account
PrivilegesThe access level chosen when it is createdThe same as that user
Works onOnly its own organizationEvery MSP and org the user can access
Rate limited byThe individual tokenThe user's account, shared with that user's other tokens and portal login
Created inOrganization > Admin > Settings, API Token sectionMy Account, API Token section
Best forApplications that automate an organizationPersonal scripts

To create an organization token, go to Organization > Admin > Settings, scroll to API Token, click Create Token, select an Access Level such as Observer, Network Admin, Org Admin or Super User, generate the key, copy it and save. A user token is created from My Account, also with Create Token and Generate. A user token can also be created from the API explorer by sending a POST to /api/v1/self/apitokens.

Rules worth memorizing:

  • The full key is shown only once, when it is created. Store it safely.
  • If single sign-on is enabled for the organization, you cannot create user tokens. Use an organization token instead.
  • Organization tokens are independent: using up one token's limit does not affect the others.
Org token Arate limited aloneused upOnly token A blockedUser tokenshares account limitused upAll tokens of that userand their portal login
Exam tip

Least privilege applies to tokens. A dashboard that only reads data should get an organization token with a read only access level, not one with full admin rights.

Rate limits

The REST API allows 5,000 calls per hour. The login API is rate limited after three failed logins. Webhooks push events to you, which is one reason to use them for events instead of polling.

Exploring the API

Logged in to the portal, you can open an API URL in the browser, for example {api-host}/api/v1/self/apitokens. Mist shows a Django based web interface where you can perform GET, POST, PUT and DELETE from the browser. The API Documentation link in the portal's question mark menu opens the full API reference.

Common mistakes

Calling api.mist.com for every organization. The host must match the organization's region. An EMEA 01 organization uses api.eu.mist.com.

Expecting to see a token again later. The full key is displayed only at creation.

Creating user tokens in an SSO organization. With SSO enabled, user tokens cannot be created.

Polling for events. Repeated GET calls burn the 5,000 per hour budget. Use a webhook or WebSocket for live events.

What to remember for the exam

  • 100% API architecture: everything in the portal is available through the API.
  • URL pattern https://{api-host}/api/v1/...; the host must match the cloud region.
  • GET reads, POST creates, PUT updates (arrays replaced), DELETE removes; JSON only.
  • Authentication: API token, HTTP login, OAuth2; Basic authentication deprecated September 2026.
  • Header: Authorization, with the keyword Token before the key.
  • Org tokens: Organization > Admin > Settings, rate limited per token. User tokens: My Account, rate limited per account.
  • No user tokens with SSO; the full key is shown only once.
  • 5,000 REST calls per hour.

Check yourself

  • A company with SSO enabled needs a token for a monitoring application. Which token type should it create?

    An organization token, because user tokens cannot be created when single sign-on is enabled, and organization tokens suit applications anyway.

  • A script's user token hits its rate limit. What else is affected?

    The other tokens and portal login of the same user account, because user tokens are rate limited by the account.

  • How many REST API calls per hour does Juniper Mist allow?

    5,000 calls per hour.

Topic 1 of 3 in Juniper Mist Cloud Operations

Test yourself on Juniper Mist Cloud Operations

The full Juniper JNCIA-MistAI JN0-253 question bank has 668 questions, with timed practice exams and an explanation for every answer.

This study guide is independent and is not affiliated with, endorsed by, or sponsored by Juniper. Vendor names, certification names and exam codes are trademarks of their respective owners and are used for identification only.