Add assigned parameter to the ipam/ip-addresses API endpoint #8321

Closed
opened 2025-12-29 20:35:19 +01:00 by adam · 0 comments
Owner

Originally created by @atownson on GitHub (Jul 11, 2023).

Originally assigned to: @abhi1693 on GitHub.

NetBox version

v3.5.5

Feature type

Change to existing functionality

Proposed functionality

I propose to add an assigned boolean parameter to the ipam/ip-addresses API endpoint to handle filtering IP addresses by assignments to both interfaces and FHRP groups. The assigned_to_interface parameter currently supports filtering for assignments to interfaces only.

Use case

Adding this parameter would allow users to retrieve assigned or unassigned IP addresses via the API with regard to interface and FHRP group assignments. This would help an API integration task we have in place. Currently we are getting all IP addresses and determining if the assigned_object key has a value as a workaround. This would also better align the API with the UI table for IP Addresses as it also has an Assigned column.

Database changes

None

External dependencies

None

Originally created by @atownson on GitHub (Jul 11, 2023). Originally assigned to: @abhi1693 on GitHub. ### NetBox version v3.5.5 ### Feature type Change to existing functionality ### Proposed functionality I propose to add an `assigned` boolean parameter to the ipam/ip-addresses API endpoint to handle filtering IP addresses by assignments to both interfaces and FHRP groups. The `assigned_to_interface` parameter currently supports filtering for assignments to interfaces only. ### Use case Adding this parameter would allow users to retrieve assigned or unassigned IP addresses via the API with regard to interface and FHRP group assignments. This would help an API integration task we have in place. Currently we are getting all IP addresses and determining if the `assigned_object` key has a value as a workaround. This would also better align the API with the UI table for IP Addresses as it also has an `Assigned` column. ### Database changes None ### External dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 20:35:19 +01:00
adam closed this issue 2025-12-29 20:35:19 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#8321