Where to find comprehensive list of API endpoints

[david.s...@acadiahealthcare.com]

Where can I find a comprehensive list of API endpoints for Netbox?  My current netbox installation (1.9.3) has a list of all the api endpoints available.  I want to see what endpoints are available in the latest version of Netbox so I can see if we really need to upgrade.  All I see on the website is that the API is 'fully featured' - whatever that means.  :)  

Thanks!

Dave

[Brian Candler]

Apparently there was a complete rewrite of the API in 2.0.0 - see release notes

To get the documentation, you install the new version somewhere and browse to /api/docs/ :-)

Plenty of features (other than the API) have been added since 1.9.  You can see them listed at https://github.com/digitalocean/netbox/releases

- I'd suggest just browsing to the x.x.0 versions to see when major features were added.

These include:

- Global search (2.0.0)

- Rendering of rack elevations (2.0.0)

- Virtual machines (2.2.0)

- Virtual chassis (2.3.0)

- Bulk object creation via API (2.3.0)

- Tagging (2.4.0)

- Contextual configuration data (2.4.0)

- Patch panels and cables (2.5.0)

[david.s...@acadiahealthcare.com]

OK.  I was hoping there was somewhere I could see the full api documentation without having to install the new version, but it looks like (from the 2.0 release notes) that there is full read/write capability on all objects.

Thanks!

Dave

[lamp...@gmail.com]

The API docs also existed in 1.9.3 (proof: https://github.com/digitalocean/netbox/blob/v1.9.3/netbox/netbox/urls.py#L34).

[david.s...@acadiahealthcare.com]

Yeah, I can see the documentation for 1.9.3 on my local install of Netbox.  I was just looking for something like that for version 2.0+ - without having to upgrade.  No biggie, though - it looks like full read/edit capabilities have been added for all the data models - at least that's what I gathered from looking at the 2.0 release notes.

[Aaron Russo]

You could always spin up 2.x in a container and read the api docs of of it if you didn’t want to update your instance yet.

Aaron

--
You received this message because you are subscribed to the Google Groups "NetBox" group.
To unsubscribe from this group and stop receiving emails from it, send an email to netbox-discus...@googlegroups.com.
To post to this group, send email to netbox-...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/netbox-discuss/214a4a99-332a-424d-85f0-c1510cd29630%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[david.s...@acadiahealthcare.com]

I would do that if I were a unix guy.  :)  I'm just doing some research before I reach out to the guy in our department who will be able to upgrade it - deciding if it's worth him spending time on it.

[Brian Candler]

Of course it depends what you use Netbox for; but I'd say the answer is almost certainly "yes".  The ability to record VMs, which wasn't possible before 2.2.0, is reason enough in my mind.

[steffen.w...@gmail.com]

You can find a list of the api endpoints here (latest version): https://netbox.wikimedia.org/api/docs/

[david.s...@acadiahealthcare.com]

Thats' what I was looking for - Thanks Steffen!.