WalkthroughMarvis

Troubleshoot a Device

Use the Mist API and Marvis to troubleshoot a device in two API calls.

Troubleshooting a device with Marvis is a two-step process:

  1. The first API call (Search Org Devices) identifies the MAC address of the device to troubleshoot.
  2. The second API call (Troubleshoot Org) asks Marvis to troubleshoot the device based on its MAC address.

Both calls need an API token in the Authorization header (Authorization: Token <your-api-token>). See API Token.

Step 1: Lookup Device MAC Address

This endpoint searches for devices based on the provided information (hostname, IP address, model, ...).

Call Search Org Devices with your org_id, then note the MAC address of the device in the response (mac).

Step 2: Ask Marvis to troubleshoot the device

Once the MAC address of the device has been identified, call Troubleshoot Org to ask Marvis to troubleshoot the device. Pass the same org_id in the path and the MAC address from step 1 as the mac query parameter. The response lists the issues Marvis found for the device.

On this page