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.

The full documentation can be found here.


To get the latest version from Github:

$ pip 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_per_rack('rack_name')

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(device='device_name', interface_id=interface_id)


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.

Files for python-netbox, version 0.0.8
Filename, size File type Python version Upload date Hashes
Filename, size python-netbox-0.0.8.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page