NetBox

NetBox

Certified
Enterprise Edition

Enterprise NetBox tasks to create, update, and query devices, IP addresses, and sites over the NetBox API.

Automate NetBox inventory: register or edit devices, allocate or assign IPs, and list sites or devices with filters, field selection, pagination, and internal storage output for bulk results.

How to use the NetBox plugin

Manage devices, IP addresses, sites, and contact assignments in NetBox from Kestra flows.

Authentication

All tasks require url (the NetBox API base URL, required) and token (a NetBox API token, required). Optionally set options for HTTP client configuration. Store secrets in secrets and apply connection properties globally with plugin defaults.

Tasks

device.Create creates a device — set url, token, name, deviceType, deviceRole, and site (all required). Optionally set rack, position, face, status, description, tags, and customFields. Outputs id, name, and url.

device.List lists devices — set url and token (required). Optionally set filters (map of filter parameters), limit (default 100), fields (subset of fields to return), and fetchType (FETCH, FETCH_ONE, or STORE, default FETCH). Outputs size, total, and rows/row/uri depending on fetchType.

device.Update updates a device — set url, token, and deviceId (all required). Optionally set partialUpdate (use PATCH instead of PUT, default true) and any device fields to change (name, deviceType, deviceRole, site, rack, position, face, status, description, comments, tags, customFields). Outputs id, name, and url.

contactassignment.Create assigns a contact to an object — set url, token, contentType, objectId, contactId, and roleId (all required). Optionally set priority. Outputs id, url, display, contentType, and objectId.

contactassignment.List lists contact assignments — same options as device.List. Outputs size, total, and rows/row/uri.

site.List lists sites — same options as device.List. Outputs size, total, and rows/row/uri.

ipam.AssignIpAddress creates and optionally assigns an IP address — set url and token (required). Optionally set address, prefixId (allocate next available from prefix), status, assignedObjectType, assignedObjectId, dnsName, addressDescription, role, tags, and customFields. Outputs id, address, and url.