Troubleshoot a Device or Site by Using APIs

You can use the troubleshoot API to troubleshoot devices and sites from an external portal.

Devices that you can troubleshoot include clients (wired and wireless), access points (APs), switches, and WAN Edges. You can also use the APIs to troubleshoot sites for wired, wireless, and WAN issues.

To use the Marvis APIs, you must have:

  • A valid observer API token.

  • Marvis subscription at the organization level.

  • MAC address of the device (if you want to troubleshoot a device)

  • Site ID or site name (if you want to troubleshoot a site)

Here are the details of the API queries:

  • To troubleshoot a device:

    GET /api/v1/orgs/:org_id/troubleshoot?mac=:device_mac

    If you know the hostname or username of the device, use the search API (/clients/search or /devices/search) to get the MAC address.

    You can also include the site_id option if you want the troubleshoot response to be fetched for a device in a specific site. Include the start and end options if you want the troubleshoot response for a specific duration.

  • To troubleshoot a site:

    GET /api/v1/orgs/:org_id/troubleshoot?site_id=:siteid

    You can also include the type option if you want the troubleshoot response to be fetched for a specific network issue—wired, WAN, or wireless. Note that the default type is wireless. If you have only a WAN or wired deployment, then ensure that you specify the type. Include the start and end options if you want the troubleshoot response for a specific duration.

The API query fetches a text-based response containing the problem category, reason, description, and recommendation (if applicable). Here are some sample results:

  • Troubleshoot a device (wireless client)

    https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?mac=50:xx:xx:xx:xx:c2

    Django REST framework interface showing Get Troubleshoot API call results. Status HTTP 200 OK. JSON response details client roaming and connectivity issues.

  • Troubleshoot a device (wired client)

    https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?mac=3c:xx:xx:xx:xx:46

    Screenshot of Django REST framework interface titled Get Troubleshoot showing API call results. HTTP Status Code 200 OK, JSON response with connectivity issue details: Category Connectivity, Reason Latency, high latency on switch interface. Includes Site ID, Start and End Timestamps, and buttons for OPTIONS and GET requests.

  • Troubleshoot a site (wireless)

    https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?site_id=978c48e6-6ef6-11e6-8bbf-02e208b2d34f

    Django REST framework interface showing a GET Troubleshoot API call with HTTP 200 OK status. Response indicates WiFi interference causing 66 percent RF capacity issues, affecting access points and SSIDs. Recommendations suggest radio management for automatic channel and power allocation and lowering minimum power settings. User email visible in top-right corner.

  • Troubleshoot a site (wired)

    https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?site_id=978c48e6-6ef6-11e6-8bbf-02e208b2d34f&type=wired

    Django REST framework interface showing response of Get Troubleshoot API request with HTTP 200 OK status. JSON response highlights authentication failures on switches in a site.

  • Troubleshoot a site (WAN)

    https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?site_id=978c48e6-6ef6-11e6-8bbf-02e208b2d34f&type=wan

    Django REST framework interface for troubleshooting device health. GET request to API endpoint shows a JSON response with status 200 OK, device health issue details, timestamps, and user email kswamy at mistsys dot com.

To view the API documentation, see the Mist API Reference. For more information on troubleshooting using Marvis, see Troubleshoot Org.