Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
atownson opened this issue Jul 11, 2023 · 0 comments · Fixed by #13301
Closed

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

atownson opened this issue Jul 11, 2023 · 0 comments · Fixed by #13301
Assignees
@abhi1693
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application

Comments

@atownson
Copy link
Contributor

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
@atownson atownson added the type: feature Introduction of new functionality to the application label Jul 11, 2023
@jeremystretch jeremystretch added the status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation label Jul 26, 2023
@abhi1693 abhi1693 self-assigned this Jul 29, 2023
@abhi1693 abhi1693 added status: accepted This issue has been accepted for implementation and removed status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation labels Jul 29, 2023
abhi1693 added a commit that referenced this issue Jul 29, 2023
@abhi1693
adds assigned bool for ip address API #13151
f3fe05b
@abhi1693 abhi1693 mentioned this issue Jul 29, 2023
Merged
jeremystretch added a commit that referenced this issue Aug 2, 2023
@abhi1693 @jeremystretch
Adds assigned bool for IP address API (#13301)
57860f2 
* adds assigned bool for ip address API #13151

* Add filterset test

---------

Co-authored-by: Jeremy Stretch <[email protected]>
jeremystretch added a commit that referenced this issue Aug 4, 2023
@jeremystretch
Changelog for #12750, #12889, #13033, #13151, #13343, #13369
88562d7
@jeremystretch jeremystretch mentioned this issue Aug 15, 2023
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@abhi1693 abhi1693

Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adds assigned bool for IP address API netbox-community/netbox
3 participants
@abhi1693 @jeremystretch @atownson