Add nat_inside and nat_outside to brief fields in IPAddress Serializer #146

New Issue

MrUnknownDE · 2026-04-05T16:22:15+02:00

MrUnknownDE commented

2026-04-05 16:22:15 +02:00

Originally created by @robduffy2010 on 3/16/2026

NetBox version

v4.5.4

Feature type

Change to existing functionality

Proposed functionality

When fetching devices from the API, in many cases, it can be important to get the devices NAT IP in the same query. For example, when using Netbox with Oxidized. Of course, each device could have their outside NAT IP set as the primary IP, but this could break functionality with other systems which require the device's real IP. Many systems use Netbox's API URL as an inventory source and do not have logic to perform multiple lookups.

In order to cator for using Netbox with different systems, which require either the real IP or NAT IP of a device, I propose updating the IPAddress Serializer brief fields to include the inside_nat and outside_nat fields.

https://github.com/netbox-community/netbox/blob/main/netbox/ipam/api/serializers_/ip.py#L212

If accepted, I can submit a PR for this feature.

Use case

When using Netbox with Oxidized. Of course, each device could have their outside NAT IP set as the primary IP, but this could break functionality with other systems which require the device's real IP. Many systems use Netbox's API URL as an inventory source and do not have logic to perform multiple lookups.

Database changes

NA

External dependencies

NA

*Originally created by @robduffy2010 on 3/16/2026* ### NetBox version v4.5.4 ### Feature type Change to existing functionality ### Proposed functionality When fetching devices from the API, in many cases, it can be important to get the devices NAT IP in the same query. For example, when using Netbox with Oxidized. Of course, each device could have their outside NAT IP set as the primary IP, but this could break functionality with other systems which require the device's real IP. Many systems use Netbox's API URL as an inventory source and do not have logic to perform multiple lookups. In order to cator for using Netbox with different systems, which require either the real IP or NAT IP of a device, I propose updating the IPAddress Serializer brief fields to include the inside_nat and outside_nat fields. https://github.com/netbox-community/netbox/blob/main/netbox/ipam/api/serializers_/ip.py#L212 If accepted, I can submit a PR for this feature. ### Use case When using Netbox with Oxidized. Of course, each device could have their outside NAT IP set as the primary IP, but this could break functionality with other systems which require the device's real IP. Many systems use Netbox's API URL as an inventory source and do not have logic to perform multiple lookups. ### Database changes NA ### External dependencies NA

MrUnknownDE closed this issue

2026-04-05 16:22:15 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#146