NetBox Create
CertifiedEnterprise EditionCreate device record in NetBox
NetBox Create
Create device record in NetBox
Posts a device to NetBox with existing type, role, and site slugs and optional rack, position, face, status, description, tags, and custom fields. Uses Token authentication and raises an error on non-2xx responses. Empty tag or custom field collections are skipped.
type: io.kestra.plugin.ee.netbox.device.CreateExamples
Register a new device in NetBox.
id: register_new_switch
namespace: company.team
tasks:
- id: create_device
type: io.kestra.plugin.ee.netbox.device.Create
url: "{{ secret('NETBOX_URL') }}"
token: "{{ secret('NETBOX_API_TOKEN') }}"
name: "switch-01"
deviceType: "cisco-catalyst-9300"
deviceRole: "access-switch"
site: "nyc-dc1"
rack: "rack-a01"
position: 42
face: "front"
status: "active"
addressDescription: "Access switch for production network"
tags:
- "production"
- "network"
customFields:
purchase_date: "2024-01-15"
warranty_expiration: "2027-01-15"
Properties
deviceRole *Requiredstring
Device role
Device role slug or identifier that already exists in NetBox.
deviceType *Requiredstring
Device type
Device type slug or identifier that already exists in NetBox.
name *Requiredstring
Device name
Device name as stored in NetBox.
site *Requiredstring
Site
Site slug or identifier to associate with the device.
token *Requiredstring
NetBox API token
Personal API token sent as Authorization: Token <value> for all requests.
url *Requiredstring
NetBox base URL
Base URL of the NetBox instance (for example: https://netbox.example.com). Must be reachable from the worker; trailing slash is optional.
customFields object
Custom fields
Optional custom field values keyed by NetBox field name.
description string
Description
Optional device description sent as addressDescription.
face string
Rack face
Optional rack face; use front or rear.
options Non-dynamic
HTTP client configuration
Optional HTTP client overrides (timeouts, TLS, proxies). Uses platform defaults when omitted.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
position integerstring
Position
Optional rack position in rack units.
rack string
Rack
Optional rack slug or identifier for the device.
status string
Status
Optional device status accepted by NetBox (for example: active, planned, offline).
Outputs
id integer
Device ID
Identifier of the created device returned by NetBox.
name string
Device name
Device name returned by NetBox.
url string
Device URL
API URL of the created device resource.
