NetBox custom fields let you attach any data — EOL dates, support contracts, PoE budgets — to devices, racks, sites, or IPs. Pair them with NetBox relationships to model logical topology beyond cables. Together, they turn NetBox into custom single source of truth that powers automation and audits.
NetBox ships with a robust set of core objects like devices, interfaces, IP addresses, and cables. These cover the basics of network documentation, but real-world operations demand far more detail. For example, a simple Device entry tells you the model and location, but it doesn’t capture critical operational data such as end-of-life (EOL) dates, support contract IDs, or exact rack unit (U) positioning. Without this information, teams rely on scattered spreadsheets, outdated diagrams, or tribal knowledge—leading to compliance risks, delayed audits, and configuration drift.
This is where NetBox custom fields become indispensable. They allow you to extend any object type with structured, searchable data tailored to your environment. Whether you need to track warranty expiration, power consumption, firmware versions, or even compliance tags, custom fields integrate seamlessly into the NetBox UI, API, and export tools. The result? A single, authoritative source of truth that eliminates silos and powers downstream automation.
Similarly, physical cables in NetBox show direct connections, but they fall short when modeling logical dependencies—like which switch powers a PDU, or which rack houses specific servers. NetBox relationships solve this by defining reusable, directional associations between objects. These go beyond cabling to represent real topology: power feeds, backup links, containment hierarchies, and more. Combined with custom fields, relationships create a rich, queryable data model that reflects how your network actually operates—not just how it’s wired.
| Built-in | Real-World Gap | NetBox Custom Fields & Relationships Fix |
|---|---|---|
Device | No EOL date, support contract, or precise rack U position | Attach structured data via custom fields; link to racks via relationships |
Cable | Only physical patch paths; no logical “powers / feeds / houses” | Define reusable relationships to model operational topology |
Customization > Custom Fields
NetBox custom fields extend core objects with structured data like EOL dates or support contracts. Access them via Customization > Custom Fields (URL remains /extras/custom-fields/ for backward compatibility). They are stored as JSON, support filtering, and appear in UI, REST API, and CSV exports.
Bulk Import (CSV – for beginners):
name,label,type,object_types,required,weight,search_weight,filter_logic,ui_visible,ui_editable,group_name,description,validation_regex
eol_date,EOL Date,date,dcim.device,false,100,1000,loose,always,yes,Lifecycle,"Hardware end-of-life date",
support_contract,Support Contract ID,text,dcim.device,false,200,500,loose,always,yes,Support,"Vendor contract ID",^SUP-[0-9]{6}$
site_contact,Site Contact,text,dcim.site,false,100,800,loose,always,yes,Operations,"Primary on-site contact",Use Cases:
eol_date custom field on devices tracks hardware end-of-life dates, enabling proactive refresh planning. It supports filtering (?cf_eol_date__lte=2026-01-01) and CSV exports for audit reports, preventing support gaps and compliance risks.support_contract field enforces contract ID format via regex, ensuring data consistency across thousands of devices. It appears in device views and API responses, powering automation and vendor SLA tracking.site_contact field on sites stores local contact details, making emergency response faster. It integrates into site exports and webhooks, turning NetBox into a full operations database.
NetBox Custom Fields Types
NetBox offers a variety of custom field types to match any data you need to track. Choose the right type to ensure clean input, accurate filtering, and seamless integration with reports or automation tools.
| Type | Use Case |
|---|---|
Text | Serial, notes |
Long Text | Config snippets |
Integer | Power (W), PoE |
Date | EOL, warranty |
URL | Datasheet |
Select | Tier: Gold/Silver |
Multi-select | Tags |
Pro tip: Use Select or Multi-select for NetBox custom fields that require consistency—prevent typos and enable powerful filtering (e.g., ?cf_support_tier=Gold). All types are fully supported in the UI, REST API, GraphQL, and CSV exports, making your data immediately actionable.
Customization > Custom Links
NetBox custom links add dynamic, clickable URLs to any object (devices, sites, IPs). Access via Customization > Custom Links (URL: /extras/custom-links/). They use Jinja2 templating to inject object data (e.g., {{ obj.name }}) into external systems like ticketing, monitoring, or CMDBs.
Bulk Import (CSV – for beginners):
name,content_type,text,target,weight,new_window,link_text,link_url
device_noc_ticket,dcim.device,NOC Ticket,blank,100,true,"Open in NOC","https://noc.example.com/ticket/{{ object.serial }}"
device_zabbix,dcim.device,Zabbix,blank,200,true,"Zabbix Host","https://zabbix.example.com/host/{{ obj.name | lower }}"
site_dashboard,dcim.site,Site Dashboard,blank,100,true,"Open Dashboard","https://dash.example.com/site/{{ object.serial }}"Customization > Custom Links
NetBox custom links add dynamic, clickable URLs to any object (devices, sites, IPs). Access via Customization > Custom Links (URL: /extras/custom-links/). They use Jinja2 templating to inject object data (e.g., {{ object.serial }}) into external systems like ticketing, monitoring, or CMDBs.
Bulk Import (CSV – for beginners):
name,object_types,weight,link_text,link_url,enabled,new_window,group_name,button_class
support_ticket,dcim.device,100,Open Support Ticket,https://tickets.example.com/{{ object.serial }},true,true,Support,default
vendor_portal,dcim.device,200,Vendor Portal,https://vendor.example.com/device/{{ object.serial }},true,true,Support,default
site_map,dcim.site,100,View Site Map,https://maps.example.com/site/{{ object.site }},true,false,,defaultUse Cases:
support_ticket link uses the support_contract custom field to open a pre-filled ticket in your ITSM tool — no copy-paste needed during incidents.vendor_portal link jumps straight to the OEM support page using the device serial number, speeding up RMA and firmware checks.site_map link embeds a facility floor plan or layer 1 topology via the site slug, giving field techs instant visual context.
After we add custom links, we can view new buttons in other sections. As in an example below – watch for new View Site Map button in right top corner.
NetBox custom fields and custom links transform your inventory into a powerful, extensible source of truth. With custom fields, you attach structured data—EOL dates, contract IDs, PoE budgets, or site contacts—directly to devices, sites, or IPs using JSON storage for instant filtering, reporting, and API access. Pair them with custom links to inject that data into external systems via Jinja2 templating, creating one-click actions like “Open Zabbix Host” or “Create NOC Ticket from Contract ID.” Together, they eliminate silos, reduce context switching, and power automation—making NetBox the single pane of glass for network operations, compliance, and incident response in 2025.
As 2026 approaches, NetBox custom fields become essential for lifecycle management. Use eol_date on devices to filter aging hardware (?cf_eol_date__lte=2026-12-31) and export reports via CSV or API. This ensures proactive replacements before support ends, avoiding outages and compliance risks.
Pair fields with custom links to act instantly: a Zabbix link from device name, a NOC ticket from support_contract, or a site dashboard from site_contact. These one-click actions — built with Jinja2 — embed automation into documentation, cutting response time from minutes to seconds.
Start today: import the CSV templates under Customization > Custom Fields and Custom Links (URLs: /extras/custom-fields/, /extras/custom-links/). In minutes, your NetBox evolves from static inventory into a dynamic operations platform — ready for 2026 and beyond.
—
Featured background images in this series by Logan Voss, Creative Engineer. View his portfolio at loganvoss.com.
