OrgsMarvis

troubleshootOrg

GET
/api/v1/orgs/{org_id}/troubleshoot

Troubleshoot sites, devices, clients, and wired clients for maximum of last 7 days from current time. See search APIs for device information:

NOTE: requires Marvis subscription license

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Query Parameters

mac?string

required when troubleshooting device or a client

site_id?string

required when troubleshooting site

Formatuuid
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

type?string

When troubleshooting site, type of network to troubleshoot. enum: wan, wired, wireless

Value in

  • "wan"
  • "wired"
  • "wireless"

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/troubleshoot"
{  "end": 1655151856,  "results": [    {      "category": "client",      "reason": "slow association",      "recommendation": "Ensure the IP helper-address is configured on the VLAN interface.",      "text": "Clients of the AP had slow association 8% of the time on Bhavabhi and 5 GHz. ..."    }  ],  "start": 1655065456}