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
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.mist.com/api/v1/const/alarm_defs" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"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);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
| Method | Path | What it does |
|---|---|---|
| GET | /api/v1/const/alarm_defs | getAlarmDefinitions |
| GET | /api/v1/const/ap_channels | getApChannels |
| GET | /api/v1/const/ap_led_status | getApLedDefinition |
| GET | /api/v1/const/applications | getApplications |
| GET | /api/v1/const/call_events | getCallEventsDefinitions |
| GET | /api/v1/const/client_events | getClientEventsDefinitions |
| GET | /api/v1/const/countries | getCountryCodes |
| GET | /api/v1/const/default_gateway_config | getGetawayDefaultConfig |
| GET | /api/v1/const/device_events | getDeviceEventsDefinitions |
| GET | /api/v1/const/device_models | getDeviceModels |
| GET | /api/v1/const/insight_metrics | getSiteAvailableInsightMetrics |
| GET | /api/v1/const/languages | getSiteLanguages |
| GET | /api/v1/const/mxedge_events | getMxEdgeEventsDefinitions |
| GET | /api/v1/const/mxedge_models | getMxEdgeModels |
| GET | /api/v1/const/system_eventsdeprecated | getSystemEventsDefinitions |
| GET | /api/v1/const/traffic_types | getTrafficTypes |
| GET | /api/v1/installer/orgs/{org_id}/alarmtemplates | getInstallerAlarmTemplates |
| GET | /api/v1/installer/orgs/{org_id}/deviceprofiles | getInstallerDeviceProfiles_WIP_ |
| GET | /api/v1/installer/orgs/{org_id}/devices | getInstallerListOfRenctlyClaimedDevices |
| POST | /api/v1/installer/orgs/{org_id}/devices | claimInstallerDevices |
| 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}/locate | startInstallerLocateDevice |
| POST | /api/v1/installer/orgs/{org_id}/devices/{device_mac}/unlocate | stopInstallerLocateDevice |
| 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}/rftemplates | getInstallerRfTemplatesNames |
| GET | /api/v1/installer/orgs/{org_id}/secpolicies | getInstallerSecPolicies |
| GET | /api/v1/installer/orgs/{org_id}/sitegroups | getInstallerSiteGroups |
| GET | /api/v1/installer/orgs/{org_id}/sites | getInstallerSites |
| PUT | /api/v1/installer/orgs/{org_id}/sites/{site_name} | createOrUpdateInstallerSites |
| GET | /api/v1/installer/orgs/{org_id}/sites/{site_name}/maps | getInstallerMaps |
| POST | /api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/import | importInstallerMap |
| 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}/optimize | optimizeInstallerRrm |
| POST | /api/v1/invite/verify/{token} | verifyAdminInvite |
| POST | /api/v1/login | login |
| POST | /api/v1/login/lookup | lookup |
| 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_factor | twoFactor |
| POST | /api/v1/logout | logout |
| POST | /api/v1/mobile/verify/{secret} | activateSdkInvite |
| POST | /api/v1/msps | createMsp |
| 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}/admins | getMspAdmins |
| 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}/claim | claimMspLicence |
| 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}/invites | inviteMspAdmin |
| 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}/licenses | getMspLicenses |
| PUT | /api/v1/msps/{msp_id}/licenses | moveOrDeleteMspLicenseToAnotherOrg |
| POST | /api/v1/msps/{msp_id}/logo | postMspLogo |
| DELETE | /api/v1/msps/{msp_id}/logo | deleteMspLogo |
| GET | /api/v1/msps/{msp_id}/logs | getMspLogs |
| GET | /api/v1/msps/{msp_id}/logs/count | countMspLogs |
| GET | /api/v1/msps/{msp_id}/orggroups | getMspOrgGroups |
| POST | /api/v1/msps/{msp_id}/orggroups | createMspOrgGroup |
| 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}/orgs | getMspOrgs |
| POST | /api/v1/msps/{msp_id}/orgs | createMspOrg |
| PUT | /api/v1/msps/{msp_id}/orgs | manageMspOrgs |
| GET | /api/v1/msps/{msp_id}/orgs/search | searchMspOrgs |
| GET | /api/v1/msps/{msp_id}/orgs/{org_id} | getMspOrg |
| GET | /api/v1/msps/{msp_id}/search | searchMspOrgGroup |
| GET | /api/v1/msps/{msp_id}/ssoroles | getMspSsoRoles |
| POST | /api/v1/msps/{msp_id}/ssoroles | createMspSsoRole |
| 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}/ssos | getMspSso |
| POST | /api/v1/msps/{msp_id}/ssos | createMspSso |
| 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}/failures | getMspSsoLatestFailures |
| GET | /api/v1/msps/{msp_id}/ssos/{sso_id}/metadata | getMspSsoSamlMetadata |
| GET | /api/v1/msps/{msp_id}/ssos/{sso_id}/metadata.xml | downloadMspSsoSamlMetadata |
| GET | /api/v1/msps/{msp_id}/stats/licenses | getMspOrgLicenses |
| GET | /api/v1/msps/{msp_id}/stats/orgs | getMspOrgStats |
| GET | /api/v1/msps/{msp_id}/tickets | getMspTickets |
| GET | /api/v1/msps/{msp_id}/tickets/count | countMspTickets |
| POST | /api/v1/orgs | createOrg |
| 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_cmd | getOrg128TRegistrationCommands |
| GET | /api/v1/orgs/{org_id}/admins | getOrgAdmins |
| 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.
Similar business APIs
Compare alternatives →Gmail
BusinessFlexible, RESTful access to the user's inbox
Google Analytics
BusinessCollect, configure and analyze your data to reach the right audience
Apache Superset
BusinessAPI to manage your BI dashboards and data sources on Superset
Trello
BusinessBoards, lists and cards to help you organize and prioritize your projects
Square
BusinessEasy way to take payments, manage refunds, and help customers checkout online
Mailchimp
BusinessSend marketing campaigns and transactional mails
Listed from APIs.guru (CC0).