NetBox Create

NetBox Create

Certified
Enterprise Edition

Create a contact assignment in NetBox

Posts a contact assignment to NetBox linking a contact and role to a resource object identified by content type and object ID. Optional priority accepts: primary, secondary, tertiary, or inactive.

yaml
type: io.kestra.plugin.ee.netbox.contactassignment.Create

Assign a contact as primary contact for a device.

yaml
id: assign_device_contact
namespace: company.team

tasks:
  - id: create_contact_assignment
    type: io.kestra.plugin.ee.netbox.contactassignment.Create
    url: "{{ secret('NETBOX_URL') }}"
    token: "{{ secret('NETBOX_API_TOKEN') }}"
    contentType: "dcim.device"
    objectId: 42
    contactId: 1
    roleId: 2
    priority: "primary"
Properties

Contact ID

Integer ID of the contact to assign.

Content type

NetBox content type string identifying the resource kind (for example: dcim.device, dcim.site, tenancy.tenant).

Object ID

Integer ID of the object being assigned the contact.

Role ID

Integer ID of the contact role to assign.

NetBox API token

Personal API token sent as Authorization: Token <value> for all requests.

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.

HTTP client configuration

Optional HTTP client overrides (timeouts, TLS, proxies). Uses platform defaults when omitted.

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether 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.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

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.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Reference (ref) of the pluginDefaults to apply to this task.

Priority

Optional assignment priority: primary, secondary, tertiary, or inactive.

Content type

Content type of the assigned object as returned by NetBox.

Display name

Human-readable display string returned by NetBox.

Assignment ID

Identifier of the created contact assignment returned by NetBox.

Object ID

ID of the assigned object as returned by NetBox.

Assignment URL

API URL of the created contact assignment resource.

More Plugins in this Category

AS400
AS400

Tasks that connect to AS400 via JDBC to run queries and loads.

DataInfrastructure

3 tasks

Proxmox VE
Proxmox VE

Tasks that manage the full lifecycle of QEMU VMs and LXC containers on Proxmox VE, including backups, snapshots, cluster introspection, and network inspection.

CloudInfrastructure

36 tasks

4 blueprints