starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-14 14:23:32 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Used ip filter for a prefix via the API #1756

New Issue
Closed
opened 2025-12-29 16:35:02 +01:00 by adam · 1 comment
adam commented 2025-12-29 16:35:02 +01:00
Owner
Copy Link

Originally created by @funzoneq on GitHub (May 30, 2018).

Issue type

[X] Feature request
[ ] Bug report
[ ] Documentation

Environment

  • Python version: 3.5.2
  • NetBox version: v2.3.3

Description

In netbox we have the view of which IP addresses are used in a specific prefix: https://netbox.example.com/ipam/prefixes/4/ip-addresses/ . It uses the PrefixIPAddressesView and prefix.get_child_ips() function. However there isn't a similar function for the API.

I would like to get a filter on the /ipam/ip-addresses/ resource to be able to filter on the parent prefix ID.

Originally created by @funzoneq on GitHub (May 30, 2018). ### Issue type [X] Feature request <!-- An enhancement of existing functionality --> [ ] Bug report <!-- Unexpected or erroneous behavior --> [ ] Documentation <!-- A modification to the documentation --> <!-- Please describe the environment in which you are running NetBox. (Be sure to verify that you are running the latest stable release of NetBox before submitting a bug report.) If you are submitting a bug report and have made any changes to the code base, please first validate that your bug can be recreated while running an official release. --> ### Environment * Python version: 3.5.2 * NetBox version: v2.3.3 <!-- BUG REPORTS must include: * A list of the steps needed for someone else to reproduce the bug * A description of the expected and observed behavior * Any relevant error messages (screenshots may also help) FEATURE REQUESTS must include: * A detailed description of the proposed functionality * A use case for the new feature * A rough description of any necessary changes to the database schema * Any relevant third-party libraries which would be needed --> ### Description In netbox we have the view of which IP addresses are used in a specific prefix: https://netbox.example.com/ipam/prefixes/4/ip-addresses/ . It uses the PrefixIPAddressesView and prefix.get_child_ips() function. However there isn't a similar function for the API. I would like to get a filter on the /ipam/ip-addresses/ resource to be able to filter on the parent prefix ID.
adam closed this issue 2025-12-29 16:35:02 +01:00
adam commented 2025-12-29 17:18:52 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 6, 2018):

In the interest of consistency and to avoid redundancy, all API endpoints abide by the same index/filter strategy, which doesn't always mirror the web UI. To retrieve these IPs via the API, you'll need to call the IP addresses endpoint with the parent and vrf or vrf_id filters. For example:

GET https://netbox/api/ipam/ip-addresses/?parent=192.0.2.0/24&vrf_id=10
@jeremystretch commented on GitHub (Jun 6, 2018): In the interest of consistency and to avoid redundancy, all API endpoints abide by the same index/filter strategy, which doesn't always mirror the web UI. To retrieve these IPs via the API, you'll need to call the IP addresses endpoint with the `parent` and `vrf` or `vrf_id` filters. For example: GET https://netbox/api/ipam/ip-addresses/?parent=192.0.2.0/24&vrf_id=10
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#1756
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?