Docs

Entity Examples

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

Prerequisites

  • Go 1.25 or later
  • Diode SDK for Go

Installation

go get github.com/netboxlabs/diode-sdk-go@latest

Configuration

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

target     = "grpc://localhost:8080/diode"
appName    = "example-app"
appVersion = "1.0.0"

Quick Start

Each entity example is in its own directory with a complete Go module. To run an example:

cd examples/device
go run main.go

Example Patterns

Each example includes three patterns:

  • Minimal: Only required fields
  • Extended: Required fields plus common optional fields
  • Explicit: Fully nested objects with all common fields

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

Available Entity Examples

Circuits

DCIM

Extras

IPAM

Other

Tenancy

VPN

Virtualization

Wireless

On this page