List of all statuses returned by API?

SOLVED
Martin_Rowan
Getting noticed

List of all statuses returned by API?

Hi, The API documentation is pretty good but lacks details of all return values for what I suspect are enums for the state. Specifically:

  • For device status: {{baseUrl}}/organizations/:organizationId/devices/statuses
    ...
    "status": "online"
    ...
    What are the valid return values? online, offline, ...?
 
  • For uplink status on an SD-WAN appliance: {{baseUrl}}/organizations/:organizationId/uplinks/statuses
    ...
    "status": "active"
    ...
    What are the valid return values for this? active, ready, ... ???


Thanks, Martin

1 ACCEPTED SOLUTION
AutomationDude
Building a reputation

I hear you! Was messing about with the firmware update call and one of the firmware release types was "candidate", which I'm not really clear about.

 

They definitely need to tell us all the possible return values for a call and what they mean.

 

I believe for the device status call online and offline are the only two possibilites. 

 

I was able to find this for you: 

 

https://documentation.meraki.com/MX/Monitoring_and_Reporting/Appliance_Status/MX_Uplink_Settings

 

If you look at the Uplink Status section you should be able to find the possible states. I completely agree with you though!

View solution in original post

5 REPLIES 5
AutomationDude
Building a reputation

I hear you! Was messing about with the firmware update call and one of the firmware release types was "candidate", which I'm not really clear about.

 

They definitely need to tell us all the possible return values for a call and what they mean.

 

I believe for the device status call online and offline are the only two possibilites. 

 

I was able to find this for you: 

 

https://documentation.meraki.com/MX/Monitoring_and_Reporting/Appliance_Status/MX_Uplink_Settings

 

If you look at the Uplink Status section you should be able to find the possible states. I completely agree with you though!

Thanks for the link, missed that section of the docs, though I'm cautious if the docs would reflect all possible states. I'm curious if device status is more and online/offline for example does the status change when it's rebooting, upgrading. or even in some unknown state.

The API docs show the relevant possible values for device status: https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-statuses-overview

Thanks John, my last point was a more general one of knowing what the valid set of values are for various statuses. For example:

As far as I know that is not documented.  Agree it would be nice if it was.

 

Ones I am aware of: 

get-organization-appliance-uplink-statuses "active", "ready", "failed", "not connected"

get-organization-appliance-vpn-statuses : "reachable"  "unreachable" and "unknown"

 

Get notified when there are additional replies to this discussion.
Welcome to the Meraki Community!
To start contributing, simply sign in with your Cisco account. If you don't yet have a Cisco account, you can sign up.