Skip to content

Expose tagged objects through REST api #17793

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.

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

Closed
LachTrip opened this issue Oct 16, 2024 · 2 comments
Closed

Expose tagged objects through REST api #17793

LachTrip opened this issue Oct 16, 2024 · 2 comments
Assignees
Labels
complexity: medium Requires a substantial but not unusual amount of effort to implement netbox status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Milestone

Comments

@LachTrip
Copy link

LachTrip commented Oct 16, 2024

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

@LachTrip LachTrip added status: needs triage This issue is awaiting triage by a maintainer type: feature Introduction of new functionality to the application labels Oct 16, 2024
@davekempe
Copy link

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.

@jeremystretch jeremystretch added the netbox label Nov 1, 2024 — with Linear
@jeremystretch jeremystretch added needs milestone Awaiting prioritization for inclusion with a future NetBox release status: backlog Awaiting selection for work complexity: medium Requires a substantial but not unusual amount of effort to implement and removed status: needs triage This issue is awaiting triage by a maintainer labels Feb 6, 2025
@jeremystretch
Copy link
Member

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

@jeremystretch jeremystretch self-assigned this Feb 19, 2025
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed needs milestone Awaiting prioritization for inclusion with a future NetBox release status: backlog Awaiting selection for work labels Feb 19, 2025
@jeremystretch jeremystretch added this to the v4.3 milestone Feb 19, 2025
jeremystretch added a commit that referenced this issue Feb 25, 2025
* Closes #17793: Introduce a REST API endpoint for tagged objects

* Add missing object_id filter to TaggedItemFilterSet
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 27, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
complexity: medium Requires a substantial but not unusual amount of effort to implement netbox status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Development

No branches or pull requests

3 participants