NetBox

App · 16 actions

Keep NetBox, your network's source of truth, up to date from workflows: find devices and who has an IP address, add and update devices and virtual machines, take the next free IP address in a prefix and give it back, and add journal notes. Start a workflow when a device or IP address is added, or a record changes.

Actions

ActionWhat it does
Add journal entryAdd a note to a device's, virtual machine's, IP address's, prefix's or site's journal in NetBox, such as a ticket reference or a change made.
Create deviceAdd a device at a site, with its type, role, status, serial number, asset tag, tenant and rack, such as from a provisioning workflow.
Create virtual machineAdd a virtual machine on a cluster or at a site, with its status, role, tenant, VCPUs, memory and disk.
Delete deviceDelete a device from NetBox, with its interfaces and journal, such as once it has left the building.
Delete IP addressDelete an IP address from NetBox, so it's free again, such as when a server is retired.
Delete virtual machineDelete a virtual machine from NetBox, with its interfaces and journal, such as once it has been destroyed.
Find devicesFind devices by name, serial number, asset tag or other words, at a site, with a role, status or tenant, with their primary IP address.
Find IP addressesLook up who has an IP address, or find addresses by DNS name or words, in a prefix, with a status, of a tenant or on a device.
Find prefixesFind prefixes by words, the address they contain, site, status or tenant, with their VLAN.
Find virtual machinesFind virtual machines by name or words, site, cluster, status, role or tenant, with their primary IP address.
Get deviceLook up a device by its name, serial number or asset tag: its site, rack, role, type, status and tenant, its interfaces and its IP addresses.
Get next free IP addressTake the next free IP address in a prefix and reserve it in NetBox, with its DNS name, description, status and tenant, such as for a new server.
List sitesList the sites in NetBox, by name, with their status, facility and region.
Update deviceChange a device's status (such as to Offline or Decommissioning), name, serial number, asset tag, tenant, role, description or comments.
Update IP addressChange an IP address's status, DNS name, description or tenant.
Update virtual machineChange a virtual machine's status (such as to Decommissioning), name, role, tenant, VCPUs, memory, disk, description or comments.

Add journal entry

Add a note to a device's, virtual machine's, IP address's, prefix's or site's journal in NetBox, such as a ticket reference or a change made.

Inputs

Add it toobject_typetext
What kind of record it's about.One of: device, virtual_machine (Virtual machine), ip_address (IP address), prefix, site. Default: device.
RecordrecordtextRequired
Which one: its ID, link or name (a device also its asset tag or serial number, an IP address the address itself, a prefix its CIDR).
CommentscommentstextRequired
What the entry says, in Markdown, such as Replaced a failed disk (CHG-1042).
Kindentry_kindtext
How NetBox colours it. Defaults to Info.One of: info, success, warning, danger. Default: info.

Outputs

commentstext
What it says
createdtext
When it was added
idnumber
The journal entry's ID
kindtext
Its kind: info, success, warning or danger
linktext
A link to it in NetBox
objecttext
The record it's on, as NetBox shows it
object_idnumber
The ID of the record it's on
object_typetext
What it's on, as NetBox names it, such as dcim.device
Example output
{
  "comments": "Replaced a failed disk (CHG-1042).",
  "created": "2026-11-06T18:30:00.000000Z",
  "id": 4,
  "kind": "info",
  "link": "https://netbox.example.com/extras/journal-entries/4/",
  "object": "ams-web-01 (A-10002)",
  "object_id": 2,
  "object_type": "dcim.device"
}

Create device

Add a device at a site, with its type, role, status, serial number, asset tag, tenant and rack, such as from a provisioning workflow.

Inputs

NamenametextRequired
The device's name, such as ams-web-02.
Device typedevice_typetextRequired
Its make and model, such as PowerEdge R650.
Device roleroletextRequired
What it does, such as Server or Core switch.
SitesitetextRequired
Where it is.
Statusstatustext
Its status. Defaults to Active.One of: offline, active, planned, staged, failed, inventory, decommissioning. Default: active.
Serial numberserialtext
Its serial number.
Asset tagasset_tagtext
Its asset tag, which no other device may have.
Tenanttenanttext
Who it belongs to.
Rackracktext
The rack it's in, at that site. Leave blank if it isn't racked.
Descriptiondescriptiontext
A short description.
Commentscommentstext
Longer notes, in Markdown.

Outputs

asset_tagtext
Its asset tag
commentstext
Its comments
createdtext
When it was added
descriptiontext
Its description
device_typetext
Its device type (model), such as PowerEdge R650
device_type_idnumber
The device type's ID
idnumber
The device's ID, for other NetBox steps
last_updatedtext
When it last changed
linktext
A link to it in NetBox
locationtext
Its location within the site, if set
manufacturertext
The device type's manufacturer
nametext
Its name
platformtext
Its platform, such as Ubuntu 24.04, if set
positionnumber
Its position in the rack (U); 0 if not racked
primary_iptext
Its primary IP address, with its mask, such as 10.10.20.10/24
primary_ip4text
Its primary IPv4 address, with its mask
primary_ip6text
Its primary IPv6 address, with its mask
racktext
The rack it's in, if any
roletext
Its role, such as Server or Core switch
role_idnumber
The role's ID
serialtext
Its serial number
sitetext
The site it's at
site_idnumber
The site's ID
statustext
Its status, such as active, offline or decommissioning
tenanttext
The tenant it belongs to, if any
tenant_idnumber
The tenant's ID; 0 if none
Example output
{
  "asset_tag": "A-10002",
  "comments": "",
  "created": "2026-11-06T18:18:17.737707Z",
  "description": "",
  "device_type": "PowerEdge R650",
  "device_type_id": 2,
  "id": 2,
  "last_updated": "2026-11-06T18:18:19.132036Z",
  "link": "https://netbox.example.com/dcim/devices/2/",
  "location": "",
  "manufacturer": "Dell",
  "name": "ams-web-01",
  "platform": "Ubuntu 24.04",
  "position": 20.0,
  "primary_ip": "10.10.20.10/24",
  "primary_ip4": "10.10.20.10/24",
  "primary_ip6": "",
  "rack": "R101",
  "role": "Server",
  "role_id": 2,
  "serial": "7XK2M33",
  "site": "Amsterdam DC1",
  "site_id": 1,
  "status": "active",
  "tenant": "Platform team",
  "tenant_id": 1
}

Create virtual machine

Add a virtual machine on a cluster or at a site, with its status, role, tenant, VCPUs, memory and disk.

Inputs

NamenametextRequired
The virtual machine's name, such as ams-app-vm02.
Clusterclustertext
The cluster it runs on. Give this, a site, or both.
Sitesitetext
The site it's at. Give this, a cluster, or both.
Statusstatustext
Its status. Defaults to Active.One of: offline, active, planned, staged, failed, decommissioning, paused. Default: active.
Roleroletext
What it does, such as Server.
Tenanttenanttext
Who it belongs to.
VCPUsvcpusnumber
How many virtual CPUs.At least 0.
Memory (MB)memory_mbnumber
Its memory in MB, such as 8192 for 8 GB.At least 0.
Disk (MB)disk_mbnumber
Its disk space in MB, such as 100000 for 100 GB.At least 0.
Descriptiondescriptiontext
A short description.
Commentscommentstext
Longer notes, in Markdown.

Outputs

clustertext
The cluster it runs on, if set
cluster_idnumber
The cluster's ID; 0 if none
commentstext
Its comments
createdtext
When it was added
descriptiontext
Its description
disk_mbnumber
Its disk space in MB; 0 if not set
idnumber
The virtual machine's ID, for other NetBox steps
last_updatedtext
When it last changed
linktext
A link to it in NetBox
memory_mbnumber
Its memory in MB; 0 if not set
nametext
Its name
platformtext
Its platform, such as Ubuntu 24.04, if set
primary_iptext
Its primary IP address, with its mask
roletext
Its role, if set
role_idnumber
The role's ID; 0 if none
sitetext
The site it's at, if set
site_idnumber
The site's ID; 0 if none
statustext
Its status, such as active, offline or decommissioning
tenanttext
The tenant it belongs to, if any
tenant_idnumber
The tenant's ID; 0 if none
vcpusnumber
How many virtual CPUs it has; 0 if not set
Example output
{
  "cluster": "AMS-Cluster-1",
  "cluster_id": 1,
  "comments": "",
  "created": "2026-11-06T18:18:20.100000Z",
  "description": "",
  "disk_mb": 81920,
  "id": 1,
  "last_updated": "2026-11-06T18:18:20.260158Z",
  "link": "https://netbox.example.com/virtualization/virtual-machines/1/",
  "memory_mb": 8192,
  "name": "ams-app-vm01",
  "platform": "Ubuntu 24.04",
  "primary_ip": "10.10.20.50/24",
  "role": "Server",
  "role_id": 2,
  "site": "Amsterdam DC1",
  "site_id": 1,
  "status": "active",
  "tenant": "Platform team",
  "tenant_id": 1,
  "vcpus": 4.0
}

Delete device

Delete a device from NetBox, with its interfaces and journal, such as once it has left the building. Its IP addresses stay, unassigned.

Inputs

DevicedevicetextRequired
The device: its ID (from a trigger or an earlier step), link, name, asset tag or serial number.

Outputs

deletedtrue/false
True once it's deleted
idnumber
The deleted record's ID
nametext
The name it had
Example output
{
  "deleted": true,
  "id": 7,
  "name": "ams-web-02"
}

Delete IP address

Delete an IP address from NetBox, so it's free again, such as when a server is retired.

Inputs

IP addressip_addresstextRequired
The address, such as 10.10.20.5 or 10.10.20.5/24, or its ID or link.

Outputs

addresstext
The address it had, with its mask
deletedtrue/false
True once it's deleted
dns_nametext
The DNS name it had
idnumber
The deleted IP address's ID
Example output
{
  "address": "10.10.20.2/24",
  "deleted": true,
  "dns_name": "ams-web-02.ams.example.net",
  "id": 7
}

Delete virtual machine

Delete a virtual machine from NetBox, with its interfaces and journal, such as once it has been destroyed. Its IP addresses stay, unassigned.

Inputs

Virtual machinevirtual_machinetextRequired
The virtual machine: its ID (from a trigger or an earlier step), link or name.

Outputs

deletedtrue/false
True once it's deleted
idnumber
The deleted record's ID
nametext
The name it had
Example output
{
  "deleted": true,
  "id": 2,
  "name": "ams-app-vm02"
}

Find devices

Find devices by name, serial number, asset tag or other words, at a site, with a role, status or tenant, with their primary IP address.

Inputs

Searchsearchtext
Words in the name, serial number, asset tag or description, such as ams-web or 7XK2M33. Leave blank to list every device.
Sitesitetext
Only devices at this site.
Device roleroletext
Only devices with this role.
Statusstatustext
Only devices with this status.One of: offline, active, planned, staged, failed, inventory, decommissioning.
Tenanttenanttext
Only devices of this tenant.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
deviceslist
The devices found, by name
totalnumber
How many match in all
Example output
{
  "count": 1,
  "devices": [
    {
      "asset_tag": "A-10002",
      "comments": "",
      "created": "2026-11-06T18:18:17.737707Z",
      "description": "",
      "device_type": "PowerEdge R650",
      "device_type_id": 2,
      "id": 2,
      "last_updated": "2026-11-06T18:18:19.132036Z",
      "link": "https://netbox.example.com/dcim/devices/2/",
      "location": "",
      "manufacturer": "Dell",
      "name": "ams-web-01",
      "platform": "Ubuntu 24.04",
      "position": 20.0,
      "primary_ip": "10.10.20.10/24",
      "primary_ip4": "10.10.20.10/24",
      "primary_ip6": "",
      "rack": "R101",
      "role": "Server",
      "role_id": 2,
      "serial": "7XK2M33",
      "site": "Amsterdam DC1",
      "site_id": 1,
      "status": "active",
      "tenant": "Platform team",
      "tenant_id": 1
    }
  ],
  "total": 1
}

Find IP addresses

Look up who has an IP address, or find addresses by DNS name or words, in a prefix, with a status, of a tenant or on a device.

Inputs

Address or wordssearchtext
An address, such as 10.10.20.5, or words in the DNS name or description. Leave blank to list every address.
Prefixprefixtext
Only addresses in this prefix.
Statusstatustext
Only addresses with this status.One of: active, reserved, deprecated, dhcp, slaac.
Tenanttenanttext
Only addresses of this tenant.
Devicedevicetext
Only addresses on this device: its ID, name, asset tag or serial number.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
ip_addresseslist
The IP addresses found, in address order
totalnumber
How many match in all
Example output
{
  "count": 1,
  "ip_addresses": [
    {
      "address": "10.10.20.10/24",
      "assigned_to": "ams-web-01 eth0",
      "created": "2026-11-06T18:18:18.986440Z",
      "description": "",
      "device": "ams-web-01",
      "device_id": 2,
      "dns_name": "ams-web-01.ams.example.net",
      "family": 4,
      "id": 2,
      "interface": "eth0",
      "ip": "10.10.20.10",
      "last_updated": "2026-11-06T18:18:18.986453Z",
      "link": "https://netbox.example.com/ipam/ip-addresses/2/",
      "prefix_length": 24,
      "role": "",
      "status": "active",
      "tenant": "Platform team",
      "tenant_id": 1,
      "virtual_machine": "",
      "virtual_machine_id": 0,
      "vrf": ""
    }
  ],
  "total": 1
}

Find prefixes

Find prefixes by words, the address they contain, site, status or tenant, with their VLAN.

Inputs

Searchsearchtext
Words in the prefix or description, such as 10.10. or servers.
Containscontainstext
Only prefixes holding this address or prefix, such as 10.10.20.5.
Sitesitetext
Only prefixes for this site.
Statusstatustext
Only prefixes with this status.One of: container, active, reserved, deprecated.
Tenanttenanttext
Only prefixes of this tenant.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
prefixeslist
The prefixes found, in address order
totalnumber
How many match in all
Example output
{
  "count": 1,
  "prefixes": [
    {
      "description": "AMS server network",
      "id": 2,
      "is_pool": false,
      "link": "https://netbox.example.com/ipam/prefixes/2/",
      "prefix": "10.10.20.0/24",
      "role": "",
      "scope": "Amsterdam DC1",
      "site": "Amsterdam DC1",
      "status": "active",
      "tenant": "Platform team",
      "tenant_id": 1,
      "vlan": "Servers (20)",
      "vlan_vid": 20,
      "vrf": ""
    }
  ],
  "total": 1
}

Find virtual machines

Find virtual machines by name or words, site, cluster, status, role or tenant, with their primary IP address.

Inputs

Searchsearchtext
Words in the name or description. Leave blank to list every virtual machine.
Sitesitetext
Only virtual machines at this site.
Clusterclustertext
Only virtual machines on this cluster.
Statusstatustext
Only virtual machines with this status.One of: offline, active, planned, staged, failed, decommissioning, paused.
Roleroletext
Only virtual machines with this role.
Tenanttenanttext
Only virtual machines of this tenant.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
totalnumber
How many match in all
virtual_machineslist
The virtual machines found, by name
Example output
{
  "count": 1,
  "total": 1,
  "virtual_machines": [
    {
      "cluster": "AMS-Cluster-1",
      "cluster_id": 1,
      "comments": "",
      "created": "2026-11-06T18:18:20.100000Z",
      "description": "",
      "disk_mb": 81920,
      "id": 1,
      "last_updated": "2026-11-06T18:18:20.260158Z",
      "link": "https://netbox.example.com/virtualization/virtual-machines/1/",
      "memory_mb": 8192,
      "name": "ams-app-vm01",
      "platform": "Ubuntu 24.04",
      "primary_ip": "10.10.20.50/24",
      "role": "Server",
      "role_id": 2,
      "site": "Amsterdam DC1",
      "site_id": 1,
      "status": "active",
      "tenant": "Platform team",
      "tenant_id": 1,
      "vcpus": 4.0
    }
  ]
}

Get device

Look up a device by its name, serial number or asset tag: its site, rack, role, type, status and tenant, its interfaces and its IP addresses.

Inputs

DevicedevicetextRequired
The device: its ID (from a trigger or an earlier step), link, name, asset tag or serial number.

Outputs

asset_tagtext
Its asset tag
commentstext
Its comments
createdtext
When it was added
descriptiontext
Its description
device_typetext
Its device type (model), such as PowerEdge R650
device_type_idnumber
The device type's ID
idnumber
The device's ID, for other NetBox steps
interfaceslist
Its interfaces, with the IP addresses on each
ip_addresseslist
Every IP address on its interfaces
last_updatedtext
When it last changed
linktext
A link to it in NetBox
locationtext
Its location within the site, if set
manufacturertext
The device type's manufacturer
nametext
Its name
platformtext
Its platform, such as Ubuntu 24.04, if set
positionnumber
Its position in the rack (U); 0 if not racked
primary_iptext
Its primary IP address, with its mask, such as 10.10.20.10/24
primary_ip4text
Its primary IPv4 address, with its mask
primary_ip6text
Its primary IPv6 address, with its mask
racktext
The rack it's in, if any
roletext
Its role, such as Server or Core switch
role_idnumber
The role's ID
serialtext
Its serial number
sitetext
The site it's at
site_idnumber
The site's ID
statustext
Its status, such as active, offline or decommissioning
tenanttext
The tenant it belongs to, if any
tenant_idnumber
The tenant's ID; 0 if none
Example output
{
  "asset_tag": "A-10002",
  "comments": "",
  "created": "2026-11-06T18:18:17.737707Z",
  "description": "",
  "device_type": "PowerEdge R650",
  "device_type_id": 2,
  "id": 2,
  "interfaces": [
    {
      "description": "",
      "enabled": true,
      "id": 1,
      "ip_addresses": [
        "10.10.20.10/24"
      ],
      "mac_address": "",
      "name": "eth0",
      "type": "SFP+ (10GE)"
    }
  ],
  "ip_addresses": [
    {
      "address": "10.10.20.10/24",
      "assigned_to": "ams-web-01 eth0",
      "created": "2026-11-06T18:18:18.986440Z",
      "description": "",
      "device": "ams-web-01",
      "device_id": 2,
      "dns_name": "ams-web-01.ams.example.net",
      "family": 4,
      "id": 2,
      "interface": "eth0",
      "ip": "10.10.20.10",
      "last_updated": "2026-11-06T18:18:18.986453Z",
      "link": "https://netbox.example.com/ipam/ip-addresses/2/",
      "prefix_length": 24,
      "role": "",
      "status": "active",
      "tenant": "Platform team",
      "tenant_id": 1,
      "virtual_machine": "",
      "virtual_machine_id": 0,
      "vrf": ""
    }
  ],
  "last_updated": "2026-11-06T18:18:19.132036Z",
  "link": "https://netbox.example.com/dcim/devices/2/",
  "location": "",
  "manufacturer": "Dell",
  "name": "ams-web-01",
  "platform": "Ubuntu 24.04",
  "position": 20.0,
  "primary_ip": "10.10.20.10/24",
  "primary_ip4": "10.10.20.10/24",
  "primary_ip6": "",
  "rack": "R101",
  "role": "Server",
  "role_id": 2,
  "serial": "7XK2M33",
  "site": "Amsterdam DC1",
  "site_id": 1,
  "status": "active",
  "tenant": "Platform team",
  "tenant_id": 1
}

Get next free IP address

Take the next free IP address in a prefix and reserve it in NetBox, with its DNS name, description, status and tenant, such as for a new server. Or only look at which one it would be.

Inputs

PrefixprefixtextRequired
The prefix to take it from, such as 10.10.20.0/24.
Reserve itreservetrue/false
Save the address in NetBox, so nothing else gets it. Turn off to only look at which address is next.Default: true.
DNS namedns_nametext
Its DNS name, such as ams-web-02.example.net.
Descriptiondescriptiontext
What it's for, such as the ticket.
Statusstatustext
Its status. Defaults to Active.One of: active, reserved, deprecated, dhcp, slaac. Default: active.
Tenanttenanttext
Who it belongs to.

Outputs

addresstext
The address with its mask, such as 10.10.20.5/24
assigned_totext
The device or virtual machine and interface it's on
createdtext
When it was added
descriptiontext
Its description
devicetext
The device it's on, if any
device_idnumber
That device's ID; 0 if none
dns_nametext
Its DNS name
familynumber
4 for IPv4, 6 for IPv6
idnumber
The IP address's ID, for other NetBox steps
interfacetext
The interface it's on, if any
iptext
The address without its mask, such as 10.10.20.5
last_updatedtext
When it last changed
linktext
A link to it in NetBox
prefixtext
The prefix it came from, such as 10.10.20.0/24
prefix_lengthnumber
Its mask length, such as 24
reservedtrue/false
True when it was saved in NetBox; false when it was only looked up, with an ID of 0
roletext
Its role, such as vip or loopback, if set
statustext
Its status, such as active, reserved or deprecated
tenanttext
The tenant it belongs to, if any
tenant_idnumber
The tenant's ID; 0 if none
virtual_machinetext
The virtual machine it's on, if any
virtual_machine_idnumber
That virtual machine's ID; 0 if none
vrftext
Its VRF, if any
Example output
{
  "address": "10.10.20.2/24",
  "assigned_to": "",
  "created": "2026-11-06T18:18:18.986440Z",
  "description": "",
  "device": "",
  "device_id": 0,
  "dns_name": "ams-web-02.ams.example.net",
  "family": 4,
  "id": 7,
  "interface": "",
  "ip": "10.10.20.2",
  "last_updated": "2026-11-06T18:18:18.986453Z",
  "link": "https://netbox.example.com/ipam/ip-addresses/7/",
  "prefix": "10.10.20.0/24",
  "prefix_length": 24,
  "reserved": true,
  "role": "",
  "status": "active",
  "tenant": "Platform team",
  "tenant_id": 1,
  "virtual_machine": "",
  "virtual_machine_id": 0,
  "vrf": ""
}

List sites

List the sites in NetBox, by name, with their status, facility and region.

Inputs

Searchsearchtext
Words in the name, facility or address.
Statusstatustext
Only sites with this status.One of: planned, staging, active, decommissioning, retired.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
siteslist
The sites found, by name
totalnumber
How many match in all
Example output
{
  "count": 1,
  "sites": [
    {
      "description": "",
      "facility": "Equinix AM3",
      "group": "",
      "id": 1,
      "link": "https://netbox.example.com/dcim/sites/1/",
      "name": "Amsterdam DC1",
      "physical_address": "",
      "region": "",
      "slug": "ams-dc1",
      "status": "active",
      "tenant": "Platform team",
      "time_zone": ""
    }
  ],
  "total": 1
}

Update device

Change a device's status (such as to Offline or Decommissioning), name, serial number, asset tag, tenant, role, description or comments. Blank fields stay as they are.

Inputs

DevicedevicetextRequired
The device: its ID (from a trigger or an earlier step), link, name, asset tag or serial number.
Statusstatustext
A new status. Leave blank to keep it.One of: offline, active, planned, staged, failed, inventory, decommissioning.
Namenametext
A new name. Leave blank to keep it.
Serial numberserialtext
A new serial number. Leave blank to keep it.
Asset tagasset_tagtext
A new asset tag. Leave blank to keep it.
Tenanttenanttext
A new tenant. Leave blank to keep it.
Device roleroletext
A new role. Leave blank to keep it.
Descriptiondescriptiontext
A new description. Leave blank to keep it.
Commentscommentstext
New comments, which replace the old ones. Leave blank to keep it.

Outputs

asset_tagtext
Its asset tag
commentstext
Its comments
createdtext
When it was added
descriptiontext
Its description
device_typetext
Its device type (model), such as PowerEdge R650
device_type_idnumber
The device type's ID
idnumber
The device's ID, for other NetBox steps
last_updatedtext
When it last changed
linktext
A link to it in NetBox
locationtext
Its location within the site, if set
manufacturertext
The device type's manufacturer
nametext
Its name
platformtext
Its platform, such as Ubuntu 24.04, if set
positionnumber
Its position in the rack (U); 0 if not racked
primary_iptext
Its primary IP address, with its mask, such as 10.10.20.10/24
primary_ip4text
Its primary IPv4 address, with its mask
primary_ip6text
Its primary IPv6 address, with its mask
racktext
The rack it's in, if any
roletext
Its role, such as Server or Core switch
role_idnumber
The role's ID
serialtext
Its serial number
sitetext
The site it's at
site_idnumber
The site's ID
statustext
Its status, such as active, offline or decommissioning
tenanttext
The tenant it belongs to, if any
tenant_idnumber
The tenant's ID; 0 if none
Example output
{
  "asset_tag": "A-10002",
  "comments": "",
  "created": "2026-11-06T18:18:17.737707Z",
  "description": "",
  "device_type": "PowerEdge R650",
  "device_type_id": 2,
  "id": 2,
  "last_updated": "2026-11-06T18:18:19.132036Z",
  "link": "https://netbox.example.com/dcim/devices/2/",
  "location": "",
  "manufacturer": "Dell",
  "name": "ams-web-01",
  "platform": "Ubuntu 24.04",
  "position": 20.0,
  "primary_ip": "10.10.20.10/24",
  "primary_ip4": "10.10.20.10/24",
  "primary_ip6": "",
  "rack": "R101",
  "role": "Server",
  "role_id": 2,
  "serial": "7XK2M33",
  "site": "Amsterdam DC1",
  "site_id": 1,
  "status": "active",
  "tenant": "Platform team",
  "tenant_id": 1
}

Update IP address

Change an IP address's status, DNS name, description or tenant. Blank fields stay as they are.

Inputs

IP addressip_addresstextRequired
The address, such as 10.10.20.5 or 10.10.20.5/24, or its ID or link.
Statusstatustext
A new status. Leave blank to keep it.One of: active, reserved, deprecated, dhcp, slaac.
DNS namedns_nametext
A new DNS name. Leave blank to keep it.
Descriptiondescriptiontext
A new description. Leave blank to keep it.
Tenanttenanttext
A new tenant. Leave blank to keep it.

Outputs

addresstext
The address with its mask, such as 10.10.20.5/24
assigned_totext
The device or virtual machine and interface it's on
createdtext
When it was added
descriptiontext
Its description
devicetext
The device it's on, if any
device_idnumber
That device's ID; 0 if none
dns_nametext
Its DNS name
familynumber
4 for IPv4, 6 for IPv6
idnumber
The IP address's ID, for other NetBox steps
interfacetext
The interface it's on, if any
iptext
The address without its mask, such as 10.10.20.5
last_updatedtext
When it last changed
linktext
A link to it in NetBox
prefix_lengthnumber
Its mask length, such as 24
roletext
Its role, such as vip or loopback, if set
statustext
Its status, such as active, reserved or deprecated
tenanttext
The tenant it belongs to, if any
tenant_idnumber
The tenant's ID; 0 if none
virtual_machinetext
The virtual machine it's on, if any
virtual_machine_idnumber
That virtual machine's ID; 0 if none
vrftext
Its VRF, if any
Example output
{
  "address": "10.10.20.10/24",
  "assigned_to": "ams-web-01 eth0",
  "created": "2026-11-06T18:18:18.986440Z",
  "description": "",
  "device": "ams-web-01",
  "device_id": 2,
  "dns_name": "ams-web-01.ams.example.net",
  "family": 4,
  "id": 2,
  "interface": "eth0",
  "ip": "10.10.20.10",
  "last_updated": "2026-11-06T18:18:18.986453Z",
  "link": "https://netbox.example.com/ipam/ip-addresses/2/",
  "prefix_length": 24,
  "role": "",
  "status": "active",
  "tenant": "Platform team",
  "tenant_id": 1,
  "virtual_machine": "",
  "virtual_machine_id": 0,
  "vrf": ""
}

Update virtual machine

Change a virtual machine's status (such as to Decommissioning), name, role, tenant, VCPUs, memory, disk, description or comments. Blank fields stay as they are.

Inputs

Virtual machinevirtual_machinetextRequired
The virtual machine: its ID (from a trigger or an earlier step), link or name.
Statusstatustext
A new status. Leave blank to keep it.One of: offline, active, planned, staged, failed, decommissioning, paused.
Namenametext
A new name. Leave blank to keep it.
Roleroletext
A new role. Leave blank to keep it.
Tenanttenanttext
A new tenant. Leave blank to keep it.
VCPUsvcpusnumber
How many virtual CPUs. Leave blank to keep it.At least 0.
Memory (MB)memory_mbnumber
Its memory in MB. Leave blank to keep it.At least 0.
Disk (MB)disk_mbnumber
Its disk space in MB. Leave blank to keep it.At least 0.
Descriptiondescriptiontext
A new description. Leave blank to keep it.
Commentscommentstext
New comments, which replace the old ones. Leave blank to keep it.

Outputs

clustertext
The cluster it runs on, if set
cluster_idnumber
The cluster's ID; 0 if none
commentstext
Its comments
createdtext
When it was added
descriptiontext
Its description
disk_mbnumber
Its disk space in MB; 0 if not set
idnumber
The virtual machine's ID, for other NetBox steps
last_updatedtext
When it last changed
linktext
A link to it in NetBox
memory_mbnumber
Its memory in MB; 0 if not set
nametext
Its name
platformtext
Its platform, such as Ubuntu 24.04, if set
primary_iptext
Its primary IP address, with its mask
roletext
Its role, if set
role_idnumber
The role's ID; 0 if none
sitetext
The site it's at, if set
site_idnumber
The site's ID; 0 if none
statustext
Its status, such as active, offline or decommissioning
tenanttext
The tenant it belongs to, if any
tenant_idnumber
The tenant's ID; 0 if none
vcpusnumber
How many virtual CPUs it has; 0 if not set
Example output
{
  "cluster": "AMS-Cluster-1",
  "cluster_id": 1,
  "comments": "",
  "created": "2026-11-06T18:18:20.100000Z",
  "description": "",
  "disk_mb": 81920,
  "id": 1,
  "last_updated": "2026-11-06T18:18:20.260158Z",
  "link": "https://netbox.example.com/virtualization/virtual-machines/1/",
  "memory_mb": 8192,
  "name": "ams-app-vm01",
  "platform": "Ubuntu 24.04",
  "primary_ip": "10.10.20.50/24",
  "role": "Server",
  "role_id": 2,
  "site": "Amsterdam DC1",
  "site_id": 1,
  "status": "active",
  "tenant": "Platform team",
  "tenant_id": 1,
  "vcpus": 4.0
}

On this page