NSX API call flowstats badly documented /app required

Quick post to share a discovery I made when playing with the NSX APIs. Specifically I’m talking about the flowstats call and the fact that it is wrongly documented on all versions of the NSX API Guide available at https://www.vmware.com/support/pubs/nsx_pubs.html and this drove me mad for some time before I figured out what the problem was. I must thank my colleague Richard Renardson as he effectivelty shed light on this issue!

Version 6.0.4 includes /app in the endpoint and what is shown as Request body is instead the Response body

Version 6.1 doesn’t include /app and still refers to Request body

Version 6.2 doesn’t include /app but the have (rightly) replaced Request with Response.

Long story short: the /app before /flow is still required on all version, from 6.0 to 6.2 and trying without would result in an “HTTP Status 404” error

Without /app

and that’s with the /app

I hope someone at VMware out there reads this article and get it sorted because I found it extremely frustrating! Not to mention the time I’ve lost troubleshooting something completely unnecessary! #meh

Thought of the day
Wouldn’t it be great if we had an auto-generated built-in API documentation, instead of maintaining a set of documents manually? It’s called #Automation, you know VMware? Just saying!

documentation

 

 

 

 

 

 

 

 

 

Be sociable, share!Tweet about this on TwitterShare on LinkedInShare on FacebookShare on Google+Email this to someone

1 Comment

 Add your comment

Leave a Comment

Your email address will not be published.