[GH-ISSUE #1601] Add more attributes for resource retrieval functionality - API #2631

Open
opened 2026-08-05 00:48:08 -04:00 by saavagebueno · 1 comment
Owner

Originally created by @LKA102 on GitHub (Feb 21, 2024).
Original GitHub issue: https://github.com/netbirdio/netbird/issues/1601

Is your feature request related to a problem? Please describe.
Currently, to obtain a specific device info using the API, I need to provide the device's id only (and for that, I have to look for the id first using List Peers endpoint). This poses a challenge when trying to retrieve specific device information programmatically without first listing all peers and then identifying the desired device (it also applies for other resources)

Describe the solution you'd like
I would like to request a specific resource by using other attributes like 'name' or 'ip address' as parameters (in this case, for a peer) instead of the id only.

Describe alternatives you've considered
Existing API endpoints could be enhanced by including filtering or search capabilities based on more resource attributes.

Originally created by @LKA102 on GitHub (Feb 21, 2024). Original GitHub issue: https://github.com/netbirdio/netbird/issues/1601 **Is your feature request related to a problem? Please describe.** Currently, to obtain a specific device info using the API, I need to provide the device's id only (and for that, I have to look for the id first using List Peers endpoint). This poses a challenge when trying to retrieve specific device information programmatically without first listing all peers and then identifying the desired device (it also applies for other resources) **Describe the solution you'd like** I would like to request a specific resource by using other attributes like 'name' or 'ip address' as parameters (in this case, for a peer) instead of the id only. **Describe alternatives you've considered** Existing API endpoints could be enhanced by including filtering or search capabilities based on more resource attributes.
saavagebueno added the feature-requestUXdashboardapi labels 2026-08-05 00:48:08 -04:00
Author
Owner

@PizzaLovingNerd commented on GitHub (May 30, 2026):

Peer filtering by name and IP was added in #3279. The GET /api/peers endpoint now accepts optional name and ip query parameters. Closing as implemented.

<!-- gh-comment-id:4585500698 --> @PizzaLovingNerd commented on GitHub (May 30, 2026): Peer filtering by name and IP was added in #3279. The `GET /api/peers` endpoint now accepts optional `name` and `ip` query parameters. Closing as implemented.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: DYNR/netbird#2631