Skip to main content

Python Netbox Client

python-netbox is a client for the Netbox (https://github.com/digitalocean/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.

Installation

To get the latest version from Github:

$ pip3 install python-netbox

Usage

To start with the module:

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

Examples

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='10.0.0.1/16')

Support

If you have questions or comments please send an email to thomas@tjrb.nl

Metadata

Release files for python-netbox 0.0.24

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-netbox 0.0.24
File Size Uploaded Provenance Actions
python-netbox-0.0.24.tar.gz 17.3 kB Without provenance Details for python-netbox-0.0.24.tar.gz

Release files / python-netbox-0.0.24.tar.gz

Download URL python-netbox-0.0.24.tar.gz
Size 17.3 kB
Tags Source
SHA-256 checksum
How to use checksums
994891b925366cd72e5d6522c0b574c1ebbc71a99c333b15bfa8d5277eb01372
BLAKE2b-256 checksum
How to use checksums
df6dd3fe4cd777242af0cdcd446aaf297b0a06c194b0fdb2bb7386297dc736f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.8

Security for python-netbox 0.0.24

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page