API: List all groups without listing all peers #424

Open
opened 2025-11-20 05:11:09 -05:00 by saavagebueno · 3 comments
Owner

Originally created by @clarkmcc on GitHub (Aug 22, 2023).

Is your feature request related to a problem? Please describe.
We’re creating setup keys that should be automatically associated with groups by specifying the auto_groups field but its tedious dealing with the group IDs since our servers run in multiple environments and we’re taring down staging environments often. So our alternative was to list all groups, then find the groups by name, and pass those IDs into the create setup key endpoint — i.e. we’re just resolving group IDs behind the scenes using a few calls to the API.

Describe the solution you'd like
The ability to list groups without listing peers

Discussed in Slack

Originally created by @clarkmcc on GitHub (Aug 22, 2023). **Is your feature request related to a problem? Please describe.** We’re creating setup keys that should be automatically associated with groups by specifying the auto_groups field but its tedious dealing with the group IDs since our servers run in multiple environments and we’re taring down staging environments often. So our alternative was to list all groups, then find the groups by name, and pass those IDs into the create setup key endpoint — i.e. we’re just resolving group IDs behind the scenes using a few calls to the API. **Describe the solution you'd like** The ability to list groups without listing peers [Discussed in Slack](https://netbirdio.slack.com/archives/C028VPB34NB/p1692648624689069)
saavagebueno added the feature-requestmanagement-serviceapi labels 2025-11-20 05:11:09 -05:00
Author
Owner

@nazarewk commented on GitHub (Apr 17, 2025):

I am closing this one, because I believe the current Groups API covers the use case.

@nazarewk commented on GitHub (Apr 17, 2025): I am closing this one, because I believe [the current Groups API](https://docs.netbird.io/api/resources/groups) covers the use case.
Author
Owner

@clarkmcc commented on GitHub (Apr 17, 2025):

Seems like the groups API still lists all peers even if you just want to list the groups.

@clarkmcc commented on GitHub (Apr 17, 2025): Seems like the groups API still lists all peers even if you just want to list the groups.
Author
Owner

@nazarewk commented on GitHub (Apr 18, 2025):

Ok, I'll keep it open then. Skipping fields in responses shouldn't be disruptive for existing users, but will still need to be planned for and implemented.

@nazarewk commented on GitHub (Apr 18, 2025): Ok, I'll keep it open then. Skipping fields in responses shouldn't be disruptive for existing users, but will still need to be planned for and implemented.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#424