Skip to content

Mist API API

by mist.com

API keyHTTPSBusiness
Open documentation ↗

Overview

> Version: **0.36.1** > > Date: **March 3, 2022** --- #### Available Documentation * [Postman](https://documenter.getpostman.com/view/224925/SzYgQufe) * [Open API](https://doc.mist-lab.fr/) --- #### Useful links * [Mist Homepage](https://www.mist.com) * [Mist Documentation](https://www.mist.com/documentation) * [Official API Documentation](https://api.mist.com/api/v1/docs/Home) (Mist account required) * [Mist Blog](https://www.mist.com/news/?md_post_type=post) * [Mist Updates](https://www.mist.com/documentation/category/product-updates/)

Mist API is a business API from mist.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 775 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Business
Base URL
https://api.mist.com
Version
0.36.1
Endpoints
775
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.mist.com/api/v1/const/alarm_defs" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://api.mist.com/api/v1/const/alarm_defs", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.mist.com/api/v1/const/alarm_defs",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/api/v1/const/alarm_defsgetAlarmDefinitions
GET/api/v1/const/ap_channelsgetApChannels
GET/api/v1/const/ap_led_statusgetApLedDefinition
GET/api/v1/const/applicationsgetApplications
GET/api/v1/const/call_eventsgetCallEventsDefinitions
GET/api/v1/const/client_eventsgetClientEventsDefinitions
GET/api/v1/const/countriesgetCountryCodes
GET/api/v1/const/default_gateway_configgetGetawayDefaultConfig
GET/api/v1/const/device_eventsgetDeviceEventsDefinitions
GET/api/v1/const/device_modelsgetDeviceModels
GET/api/v1/const/insight_metricsgetSiteAvailableInsightMetrics
GET/api/v1/const/languagesgetSiteLanguages
GET/api/v1/const/mxedge_eventsgetMxEdgeEventsDefinitions
GET/api/v1/const/mxedge_modelsgetMxEdgeModels
GET/api/v1/const/system_eventsdeprecatedgetSystemEventsDefinitions
GET/api/v1/const/traffic_typesgetTrafficTypes
GET/api/v1/installer/orgs/{org_id}/alarmtemplatesgetInstallerAlarmTemplates
GET/api/v1/installer/orgs/{org_id}/deviceprofilesgetInstallerDeviceProfiles_WIP_
GET/api/v1/installer/orgs/{org_id}/devicesgetInstallerListOfRenctlyClaimedDevices
POST/api/v1/installer/orgs/{org_id}/devicesclaimInstallerDevices
PUT/api/v1/installer/orgs/{org_id}/devices/{device_mac}provisionInstallerDevices
DELETE/api/v1/installer/orgs/{org_id}/devices/{device_mac}unassignInstallerRecentlyClaimedDevice
POST/api/v1/installer/orgs/{org_id}/devices/{device_mac}/locatestartInstallerLocateDevice
POST/api/v1/installer/orgs/{org_id}/devices/{device_mac}/unlocatestopInstallerLocateDevice
POST/api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}addInstallerDeviceImage
DELETE/api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}deleteInstallerDeviceImage
GET/api/v1/installer/orgs/{org_id}/rftemplatesgetInstallerRfTemplatesNames
GET/api/v1/installer/orgs/{org_id}/secpoliciesgetInstallerSecPolicies
GET/api/v1/installer/orgs/{org_id}/sitegroupsgetInstallerSiteGroups
GET/api/v1/installer/orgs/{org_id}/sitesgetInstallerSites
PUT/api/v1/installer/orgs/{org_id}/sites/{site_name}createOrUpdateInstallerSites
GET/api/v1/installer/orgs/{org_id}/sites/{site_name}/mapsgetInstallerMaps
POST/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/importimportInstallerMap
POST/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}createInstallerMap
PUT/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}updateInstallerMap
DELETE/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}deleteInstallerMap
GET/api/v1/installer/sites/{site_name}/optimizeoptimizeInstallerRrm
POST/api/v1/invite/verify/{token}verifyAdminInvite
POST/api/v1/loginlogin
POST/api/v1/login/lookuplookup
GET/api/v1/login/oauth/{provider}getOAuth2AuthorizationUrlForLogin
POST/api/v1/login/oauth/{provider}loginOAuth2
DELETE/api/v1/login/oauth/{provider}unlinkOAuth2Provider
POST/api/v1/login/two_factortwoFactor
POST/api/v1/logoutlogout
POST/api/v1/mobile/verify/{secret}activateSdkInvite
POST/api/v1/mspscreateMsp
GET/api/v1/msps/{msp_id}getMspDetails
PUT/api/v1/msps/{msp_id}updateMsp
DELETE/api/v1/msps/{msp_id}deleteMsp
GET/api/v1/msps/{msp_id}/adminsgetMspAdmins
GET/api/v1/msps/{msp_id}/admins/{admin_id}getMspAdmin
PUT/api/v1/msps/{msp_id}/admins/{admin_id}updateMspAdmin
DELETE/api/v1/msps/{msp_id}/admins/{admin_id}revokeMspAdmin
POST/api/v1/msps/{msp_id}/claimclaimMspLicence
GET/api/v1/msps/{msp_id}/insights/{metric}getMspSle
GET/api/v1/msps/{msp_id}/inventory/{device_mac}getMspInventoryByMac
POST/api/v1/msps/{msp_id}/invitesinviteMspAdmin
PUT/api/v1/msps/{msp_id}/invites/{invite_id}updateMspAdminInvite
DELETE/api/v1/msps/{msp_id}/invites/{invite_id}uninviteMspAdmin
GET/api/v1/msps/{msp_id}/licensesgetMspLicenses
PUT/api/v1/msps/{msp_id}/licensesmoveOrDeleteMspLicenseToAnotherOrg
POST/api/v1/msps/{msp_id}/logopostMspLogo
DELETE/api/v1/msps/{msp_id}/logodeleteMspLogo
GET/api/v1/msps/{msp_id}/logsgetMspLogs
GET/api/v1/msps/{msp_id}/logs/countcountMspLogs
GET/api/v1/msps/{msp_id}/orggroupsgetMspOrgGroups
POST/api/v1/msps/{msp_id}/orggroupscreateMspOrgGroup
GET/api/v1/msps/{msp_id}/orggroups/{orggroup_id}getMspOrgGroup
PUT/api/v1/msps/{msp_id}/orggroups/{orggroup_id}updateMspOrgGroup
DELETE/api/v1/msps/{msp_id}/orggroups/{orggroup_id}deleteMspOrgGroup
GET/api/v1/msps/{msp_id}/orgsgetMspOrgs
POST/api/v1/msps/{msp_id}/orgscreateMspOrg
PUT/api/v1/msps/{msp_id}/orgsmanageMspOrgs
GET/api/v1/msps/{msp_id}/orgs/searchsearchMspOrgs
GET/api/v1/msps/{msp_id}/orgs/{org_id}getMspOrg
GET/api/v1/msps/{msp_id}/searchsearchMspOrgGroup
GET/api/v1/msps/{msp_id}/ssorolesgetMspSsoRoles
POST/api/v1/msps/{msp_id}/ssorolescreateMspSsoRole
PUT/api/v1/msps/{msp_id}/ssoroles/{ssorole_id}updateMspSsoRole
DELETE/api/v1/msps/{msp_id}/ssoroles/{ssorole_id}deleteMspSsoRole
GET/api/v1/msps/{msp_id}/ssosgetMspSso
POST/api/v1/msps/{msp_id}/ssoscreateMspSso
PUT/api/v1/msps/{msp_id}/ssos/{sso_id}updateMspSso
DELETE/api/v1/msps/{msp_id}/ssos/{sso_id}deleteMspSso
GET/api/v1/msps/{msp_id}/ssos/{sso_id}/failuresgetMspSsoLatestFailures
GET/api/v1/msps/{msp_id}/ssos/{sso_id}/metadatagetMspSsoSamlMetadata
GET/api/v1/msps/{msp_id}/ssos/{sso_id}/metadata.xmldownloadMspSsoSamlMetadata
GET/api/v1/msps/{msp_id}/stats/licensesgetMspOrgLicenses
GET/api/v1/msps/{msp_id}/stats/orgsgetMspOrgStats
GET/api/v1/msps/{msp_id}/ticketsgetMspTickets
GET/api/v1/msps/{msp_id}/tickets/countcountMspTickets
POST/api/v1/orgscreateOrg
GET/api/v1/orgs/{org_id}getOrg
PUT/api/v1/orgs/{org_id}updateOrg
DELETE/api/v1/orgs/{org_id}deleteOrg
GET/api/v1/orgs/{org_id}/128routers/register_cmdgetOrg128TRegistrationCommands
GET/api/v1/orgs/{org_id}/adminsgetOrgAdmins
PUT/api/v1/orgs/{org_id}/admins/{admin_id}updateOrgAdmin
DELETE/api/v1/orgs/{org_id}/admins/{admin_id}revokeOrgAdmin

Showing the first 100 of 775 endpoints; the full list is in the documentation.

Questions

Does the Mist API API need an API key?

Yes. The Mist API API uses API key authentication; the documentation explains how to get credentials.

Does the Mist API API support HTTPS?

Yes, the Mist API API is served over HTTPS.

How many endpoints does the Mist API API have?

Its OpenAPI description lists 775 endpoints in version 0.36.1. The first 100 are shown on this page.

What are alternatives to the Mist API API?

Other Business APIs include Gmail, Google Analytics, Apache Superset, Trello, Square.

Compare alternatives →

Listed from APIs.guru (CC0).