Docs

Workflows

These guides walk through common tasks from start to finish, using example scenarios. Each one lists what you need before you start, the steps to follow in the NetBox UI (or API, where that's the natural route), and what you should end up with.

WorkflowScenarioWhat it covers
A self-contained object typeSupport contractsCreating a type and its fields, choice sets, display names, list and detail views, search
Linking to NetBox objectsStatic routes on devicesObject and multi-object fields, the Custom Objects tab, NetBox custom fields that point at a type
Relating custom objects to each otherVendors, products and licensesFields that reference other types, hierarchies, uniqueness within a parent
Bulk importing and editingLoading existing contractsCSV import, bulk edit, export, updating by re-import
Referencing more than one kind of objectServices made up of devices and VMsPolymorphic object and multi-object fields
Keeping data cleanContract data rulesRequired and unique fields, validation, unique and check constraints, custom validators
Promoting a schema between instancesStaging to productionExporting, previewing and applying a portable schema document

If a step doesn't match what you see, please open an issue.