Dashboard API: status valid responses

Solved
MaorSter
Here to help

Dashboard API: status valid responses

Hi,
I using the GET /organizations/{organizationId}/devices/statuses API. I want to cover all the possible statuses that might return from the "status" field in the response and parse it into an enum. Is there an a documentation of legal values for that field? 
(So far I have witnessed only "online" and "offline")

Thanks

1 Accepted Solution
daniel_abbatt
Getting noticed

While there isn't any documentation for the response, according to https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-statuses there is a filter which allows the values for "statuses" while querying. It states:

Valid statuses are ["online", "alerting", "offline", "dormant"]. So one could assume that these will be the only values returned.

View solution in original post

3 Replies 3
sungod
Kind of a big deal

Current statuses I see are "online", "offline", "alerting", "dormant".

 

I think it's mentioned in the documentation.

daniel_abbatt
Getting noticed

While there isn't any documentation for the response, according to https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-statuses there is a filter which allows the values for "statuses" while querying. It states:

Valid statuses are ["online", "alerting", "offline", "dormant"]. So one could assume that these will be the only values returned.

sungod
Kind of a big deal

I think the statuses just match the ones listed in the main documentation...

 

https://documentation.meraki.com/General_Administration/Cross-Platform_Content/Status_Icon_Meanings

 

...from that page:

 

Every device can display in one of four colors, indicating the status of that device:

 

Green:   The Cisco Meraki device is currently online and has no alerts

Yellow:  The Cisco Meraki device is currently online but has one or more active alerts

Red:      The Cisco Meraki device is currently offline and is inaccessible by the Cisco Meraki Dashboard

Grey:     The Cisco Meraki device is currently offline and has been offline for at least a week (dormant).

 

These indicators can be a quick and easy way to narrow down what sort of trouble a device is experiencing. A device indicating it is offline likely cannot reach it's gateway or Dashboard. A device indicating a yellow alerting status will often have additional details on the device details page. Examples include IP address conflicts or disconnection from RADIUS.

Get notified when there are additional replies to this discussion.