Jira Assets Integration
Overview
The Jira Assets integration syncs NetBox inventory into Jira Service Management Assets. NetBox remains your source of truth for network and infrastructure data; Jira Assets receives a maintained copy for IT service management, change workflows, and asset tracking.
The integration runs as a Docker container. On first run it provisions a NetBox schema in Jira Assets with all required object types and attributes. Subsequent runs create or update only objects that have changed. Run it on a schedule to keep Jira Assets current without manual exports or duplicate data entry. See Getting Started for deployment steps.
What gets synchronized
- Core infrastructure - Tags, Tenants, Regions, Sites, Locations, Racks, Device Types, Devices, Interfaces, and IP Addresses
- Virtualization - Cluster Types, Cluster Groups, Clusters, Config Contexts, Virtual Machines, VM Interfaces, and Virtual Disks
- netbox-inventory plugin - Suppliers, Purchases, Deliveries, and Inventory Assets
- netbox-lifecycle plugin - Vendors, Support SKUs, Support Contracts, Support Contract Assignments, Hardware Lifecycles, Licenses, and License Assignments. See Supported NetBox plugins.
- Custom fields - discovered automatically from NetBox and synced as
cf_-prefixed attributes - Relationships - parent-child and cross-type references (for example Device → Rack → Site → Region) appear as clickable links in Jira Assets. See Reference and text fields.
For full NetBox-to-Jira Assets object and attribute mappings, see Technical Information.
Key features
- 28 object types - core NetBox, virtualization, and netbox-inventory and netbox-lifecycle plugin objects in a single schema
- Automatic schema provisioning - creates the full Jira Assets schema on first run with no manual Jira configuration
- Navigable references - preserves infrastructure hierarchy as linked objects in Jira Assets
- Self-referential nesting - Region and Location tree structures are maintained through parent references
- Custom field discovery - NetBox custom fields are detected at runtime and synced with configurable include and exclude filters
- Incremental sync - unchanged objects are skipped; only creates and updates are sent to the Jira Assets API
- Schema compatibility check - fast or thorough pre-flight validation before each sync; standalone
--checkmode for dry runs - VM tag filtering - sync only Virtual Machines matching specific NetBox tag slugs
- Stale object cleanup - optional
GRACE_DAYS_BEFORE_STALE_DELETEto remove Jira objects no longer present in NetBox. See FAQ and Troubleshooting. - Scheduled operation - idempotent design safe for cron and other automation
Integration architecture
- Container based - runs as
quay.io/netboxlabs/netbox-jira-syncwith credentials supplied via environment variables or a.envfile - One-way sync - data flows from NetBox to Jira Assets only; no changes are written back to NetBox. See Sync behavior.
- Schema driven - object types and attributes are defined in the image and provisioned automatically in Jira Assets
- Paginated NetBox fetch - loads data from NetBox in configurable page sizes with retries on transient errors
Compatibility
Supported NetBox versions
- NetBox Cloud, NetBox Enterprise, and self-hosted NetBox with API access
- Read-only API tokens are sufficient (v1 hex tokens or v2
nbt_...tokens on NetBox 4.5+)
Supported Jira versions
- Jira Service Management (Cloud) with Assets enabled
- Jira Data Center is not currently supported. See Known limitations.
Supported NetBox plugins
- netbox-inventory - Supplier, Purchase, Delivery, and Inventory Asset object types
- netbox-lifecycle - Vendor, Support SKU, Support Contract, and related lifecycle object types
Plugin object types sync only when the plugin is installed and objects exist in your NetBox instance.
Documentation
| Document | Description |
|---|---|
| Getting Started | Pull the container, configure credentials, validate schema compatibility, and run your first sync |
| Technical Information | Object mappings, schema design, configuration parameters, and sync behavior |
| FAQ and Troubleshooting | Common issues, frequently asked questions, and remediation guidance |