Expose tagged objects through REST api #10377

Closed
opened 2025-12-29 21:30:38 +01:00 by adam · 2 comments
Owner

Originally created by @LachTrip on GitHub (Oct 17, 2024).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v4.1.1

Feature type

Data model extension

Triage priority

This is a very minor change

Proposed functionality

Add a new endpoint to get the list of the objects using a specific tag.

Use case

Looking up objects by their tags through the api currently requires numerous api calls to search through all object types. The underlying functionality exists as demonstrated by visiting the tag's display_url and looking under "Tagged Objects".

Database changes

N/A

External dependencies

N/A

Originally created by @LachTrip on GitHub (Oct 17, 2024). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v4.1.1 ### Feature type Data model extension ### Triage priority This is a very minor change ### Proposed functionality Add a new endpoint to get the list of the objects using a specific tag. ### Use case Looking up objects by their tags through the api currently requires numerous api calls to search through all object types. The underlying functionality exists as demonstrated by visiting the tag's display_url and looking under "Tagged Objects". ### Database changes N/A ### External dependencies N/A
adam added the status: acceptedtype: featurecomplexity: mediumnetbox labels 2025-12-29 21:30:38 +01:00
adam closed this issue 2025-12-29 21:30:38 +01:00
Author
Owner

@davekempe commented on GitHub (Oct 22, 2024):

This would be useful for us, as we can then easily hit the API to get a list of objects to work with. This enhances Netbox as a SoT - allowing other tools to easily get the 'next' list of things to work on.

@davekempe commented on GitHub (Oct 22, 2024): This would be useful for us, as we can then easily hit the API to get a list of objects to work with. This enhances Netbox as a SoT - allowing other tools to easily get the 'next' list of things to work on.
Author
Owner

@jeremystretch commented on GitHub (Feb 6, 2025):

This would probably manifest as a /api/extras/tagged-objects/ REST API endpoint (or similar).

@jeremystretch commented on GitHub (Feb 6, 2025): This would probably manifest as a `/api/extras/tagged-objects/` REST API endpoint (or similar).
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#10377