Skip to main content

Python NetBox Client

Project description

python-netbox is a client for the Netbox ( API. It’s based on the APIv2 which is released since version 2.0.0. It requires python 3.

The full documentation can be found here.


To get the latest version from Github:

$ pip3 install python-netbox


To start with the module:

>>> from netbox import NetBox
>>> netbox = NetBox(host='', port=32768, use_ssl=False, auth_token='token')


Get all devices:

>>> netbox.dcim.get_devices()

Get devices per rack:

>>> netbox.dcim.get_devices(rack_id=1)

Get device by name

>>> netbox.dcim.get_devices(name='device_name')

Create a site:

>>> netbox.dcim.create_site('site1', 'site1')

Delete a site:

>>> netbox.dcim.delete_site('site1')

Get IP address object:

>>> netbox.ipam.get_ip_addresses(address='')


If you have questions or comments please send an email to

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-netbox-0.0.20.tar.gz (13.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page