1. Documentation
  2. Automation with APIs

Automation with APIs

Mist API Architecture

The diagram below conceptually describes how the Mist cloud API can be used to control remote Mist network infrastructure.

HTTPS Response Codes

The full list of HTTP response codes and definitions can be found here: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html Mist uses the following response codes: Status Description 200 OK 400 Bad Request. The API endpoint exists but its syntax/payload is incorrect, detail may be given 401 Unauthorized 403 Permission Denied 404 Not found. The API endpoint doesn’t exist or resource...

Paged AP Inventory [API]

When using API calls to view all APs, you may paginate the list to indicate the current page and maximum number of objects returned in each page.  This is for an effort to support sites with very large AP inventories. Please refer to our API document (Mist login required) for the usage: https://api.mist.com/api/v1/docs/Overview#query An example...

Mist API Introduction

From the beginning Mist has been a 100% API company.  The API contains a set of tools known as endpoints for building software and applications that communicate with the Mist cloud.  The Dashboard API is a modern, RESTful API using HTTPS requests to a URL and JSON as a human-readable format. The API is available...

Create a local Python environment

Overview Install Python 3, following the installation guide: https://docs.python-guide.org/starting/installation OS X Install HomeBrew Go to http://brew.sh. Copy the Homebrew bootstrap code under “Install Homebrew”: Launch the Terminal.app application to open a console window. Paste the Homebrew bootstrap code and begin the installation. If prompted to install Apple’s “command line developer tools,” confirm by clicking the Install button. Follow the prompts...

Simple API example

See If You’re Logged in Already Get ‘whoami’ and privileges (which organization and sites I have access to) GET /api/v1/self For my test account, it returned: This is because I ran it in a new tab on a browser which I’m currently logged in to.

Using Postman

There is a tool call Postman that can be used to interact with the API without getting into coding. It is a really good place to start. You can download it here.   First you will need to generate an API Token. You can do it here and this will carry your permissions.  This is...

Postman using Variables

  In Postman you can create your own environments using variables to customize and greatly simplify your API experience.