Entity Examples

minimal: Only required fields (using flat string references)
extended: Required fields plus common optional fields
explicit: Fully nested objects with all common fields

Source: NetBox v4.6.0 Generated: 2026-07-03 00:59:24Z

Prerequisites

pip install netboxlabs-diode-sdk

Each example uses constants for configuration. You can modify these in the example code:

TARGET = "grpc://localhost:8080/diode"
CLIENT_ID = "diode"
CLIENT_SECRET = "changeme"

Each entity example is a standalone Python file. To run an example:

python examples/device.py

Each example module includes three pattern functions:

Switch between patterns by uncommenting the desired function call in main().