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

API filtering for IPAM: filters for assigned_object_id and assigned_object_type are ignored #4984

New Issue
Closed
opened 2025-12-29 19:22:52 +01:00 by adam · 2 comments
adam commented 2025-12-29 19:22:52 +01:00
Owner
Copy Link

Originally created by @jogulin on GitHub (Jun 9, 2021).

NetBox version

v2.11.3

Python version

3.6

Steps to Reproduce

Run the following command (replace the "$token" value as appropriate for your authentication, and adjust the URL as appropriate)

curl -v -k -X GET \
-H "Authorization: Token $token" \
-H "Content-Type: application/json" \
-H "Accept: application/json; indent=4" \
"https://netbox.local/api/ipam/ip-addresses/?assigned_object_id=367&assigned_object_type='dcim.interface'&limit=1"

Expected Behavior

Expect back either a single object that matches both filter conditions or an empty set

Observed Behavior

Got back the following results:

{
    "count": 1687,
    "next": "http://netbox.local/api/ipam/ip-addresses/?assigned_object_id=367&assigned_object_type=%27dcim.interface%27&limit=1&offset=1",
    "previous": null,
    "results": [
        {
            "id": 321,
            "url": "http://netbox.local/api/ipam/ip-addresses/87/",
            "display": "10.100.0.7/24",
            "family": {
                "value": 4,
                "label": "IPv4"
            },
            "address": "10.100.0.7/24",
            "vrf": null,
            "tenant": {
                "id": 24,
                "url": "http://netbox.local/api/tenancy/tenants/1/",
                "display": "Tenant 1",
                "name": "Tenant 1",
                "slug": "tenant-1"
            },
            "status": {
                "value": "active",
                "label": "Active"
            },
            "role": null,
            "assigned_object_type": null,
            "assigned_object_id": null,
            "assigned_object": null,
            "nat_inside": null,
            "nat_outside": null,
            "dns_name": "unexpected.local",
            "description": "",
            "tags": [],
            "custom_fields": {},
            "created": "2020-01-15",
            "last_updated": "2020-07-08T21:25:26.614917Z"
        }
    ]
}

The count equates to the number of IP addresses currently stored in the IPAM portion of Netbox. This would be no different than doing a GET request for all of the IP addresses every time and then manually searching each one until I found whether or not what I was searching for actually exists. In the example I provided, we have an IP address that is entered but is not assigned to any device or virtual machine.

Originally created by @jogulin on GitHub (Jun 9, 2021). ### NetBox version v2.11.3 ### Python version 3.6 ### Steps to Reproduce Run the following command (replace the "$token" value as appropriate for your authentication, and adjust the URL as appropriate) ```bash curl -v -k -X GET \ -H "Authorization: Token $token" \ -H "Content-Type: application/json" \ -H "Accept: application/json; indent=4" \ "https://netbox.local/api/ipam/ip-addresses/?assigned_object_id=367&assigned_object_type='dcim.interface'&limit=1" ``` ### Expected Behavior Expect back either a single object that matches both filter conditions or an empty set ### Observed Behavior Got back the following results: ```json { "count": 1687, "next": "http://netbox.local/api/ipam/ip-addresses/?assigned_object_id=367&assigned_object_type=%27dcim.interface%27&limit=1&offset=1", "previous": null, "results": [ { "id": 321, "url": "http://netbox.local/api/ipam/ip-addresses/87/", "display": "10.100.0.7/24", "family": { "value": 4, "label": "IPv4" }, "address": "10.100.0.7/24", "vrf": null, "tenant": { "id": 24, "url": "http://netbox.local/api/tenancy/tenants/1/", "display": "Tenant 1", "name": "Tenant 1", "slug": "tenant-1" }, "status": { "value": "active", "label": "Active" }, "role": null, "assigned_object_type": null, "assigned_object_id": null, "assigned_object": null, "nat_inside": null, "nat_outside": null, "dns_name": "unexpected.local", "description": "", "tags": [], "custom_fields": {}, "created": "2020-01-15", "last_updated": "2020-07-08T21:25:26.614917Z" } ] } ``` The count equates to the number of IP addresses currently stored in the IPAM portion of Netbox. This would be no different than doing a GET request for all of the IP addresses every time and then manually searching each one until I found whether or not what I was searching for actually exists. In the example I provided, we have an IP address that is entered but is not assigned to any device or virtual machine.
adam closed this issue 2025-12-29 19:22:52 +01:00
adam commented 2025-12-29 19:22:53 +01:00
Author
Owner
Copy Link

@jogulin commented on GitHub (Jun 10, 2021):

In addition, if I use either "assigned_object_type" or "assigned_object_id" as a filter I get the same results. Using "assigned_object_id" alone I would expect 0, 1, or 2 results (it's possible that the same ID could exist as both a dcim.interface and virtualization.vminterface).

@jogulin commented on GitHub (Jun 10, 2021): In addition, if I use either "assigned_object_type" or "assigned_object_id" as a filter I get the same results. Using "assigned_object_id" alone I would expect 0, 1, or 2 results (it's possible that the same ID could exist as both a dcim.interface and virtualization.vminterface).
adam commented 2025-12-29 19:22:53 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 10, 2021):

assigned_object_type and assigned_object_id aren't supported filters per the REST API documentation. Instead, you can use interface_id and vminterface_id to filter IP addresses by their assignment to device and VM interfaces, respectively.

@jeremystretch commented on GitHub (Jun 10, 2021): `assigned_object_type` and `assigned_object_id` aren't supported filters per the REST API documentation. Instead, you can use `interface_id` and `vminterface_id` to filter IP addresses by their assignment to device and VM interfaces, respectively.
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#4984
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?