WalkthroughMarvis

Troubleshoot a Site

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

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

  1. The first API call (Search Org Sites) identifies the ID of the site to troubleshoot.
  2. The second API call (Troubleshoot Org) asks Marvis to troubleshoot the site based on its site_id.

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

Step 1: Lookup Site ID

This endpoint searches for sites based on the provided information (name, country code, ...).

Call Search Org Sites with your org_id, then note the ID of the site in the response (id).

Step 2: Ask Marvis to troubleshoot the site

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

On this page