Skip to content

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

@atownson

Description

@atownson

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

Metadata

Metadata

Assignees

Labels

status: acceptedThis issue has been accepted for implementationtype: featureIntroduction of new functionality to the application

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions