Version: 2412.1.7
Date: December 13, 2024
This API has support for the following environment(s). Each environment has one or more base URIs defined.
Server | Base URI |
---|---|
API Host | https://api.mist.com |
Server | Base URI |
---|---|
API Host | https://api.gc1.mist.com |
Server | Base URI |
---|---|
API Host | https://api.ac2.mist.com |
Server | Base URI |
---|---|
API Host | https://api.gc2.mist.com |
Server | Base URI |
---|---|
API Host | https://api.eu.mist.com |
Server | Base URI |
---|---|
API Host | https://api.gc3.mist.com |
Server | Base URI |
---|---|
API Host | https://api.ac6.mist.com |
Server | Base URI |
---|---|
API Host | https://api.ac5.mist.com |
The default environment is Mist Global 01 and the default server is API Host.
This API uses the following authentication schemes.
apiToken (Custom Header Signature)
basicAuth (Basic Authentication)
csrfToken (Custom Header Signature)
This API uses the following header parameters for authentication.
Header | Default | Description |
---|---|---|
Authorization | None | Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equal or less privileges.
Format:
API Token value format is Token {apitoken}
Notes:
|
The request looks like this:
curl {BASEURI} \
-H 'Authorization: {AUTHORIZATION}'
GET / HTTP/1.1
Host: {HOST}
Authorization: {AUTHORIZATION}
HTTP Basic Authentication will need client credentials.
The client credentials are concatenated with a colon (:) and base64-encoded before being sent in the Authorization header.
curl {BASEURI} -u '{USERNAME}:{PASSWORD}'
GET / HTTP/1.1
Host: {HOST}
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
This API uses the following header parameters for authentication.
Header | Default | Description |
---|---|---|
X-CSRFToken | None | This protects the website against Cross Site Request Forgery, all the POST / PUT / DELETE APIs needs to have CSRF token in the AJAX Request header when using Login/Password authentication (with or without MFA)
The CSRF Token is sent back by Mist in the Cookies from the Login Response API Call:
cookies[csrftoken]
The CSRF Token must be added in the HTTP Request Headers:
|
The request looks like this:
curl {BASEURI} \
-H 'X-CSRFToken: {X-CSRFTOKEN}'
GET / HTTP/1.1
Host: {HOST}
X-CSRFToken: {X-CSRFTOKEN}
Back to top