SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-06-10 17:31:53 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

Enable renaming of groups #1589

New Issue
Open
opened 2025-11-20 05:33:21 -05:00 by saavagebueno · 6 comments
saavagebueno commented 2025-11-20 05:33:21 -05:00
Owner
Copy Link

Originally created by @Lamera on GitHub (Jan 31, 2025).

Is your feature request related to a problem? Please describe.
I defined a group and gave it a wrong name. Now I have to re-create the whole group with its policies.

Describe the solution you'd like
I simply would like to rename the group name in the Dashboard.

Describe alternatives you've considered
I thought about changing the name in the database. Perhaps I will break something by doing this.

Originally created by @Lamera on GitHub (Jan 31, 2025). **Is your feature request related to a problem? Please describe.** I defined a group and gave it a wrong name. Now I have to re-create the whole group with its policies. **Describe the solution you'd like** I simply would like to rename the group name in the Dashboard. **Describe alternatives you've considered** I thought about changing the name in the database. Perhaps I will break something by doing this.
saavagebueno added the feature-requestdashboard labels 2025-11-20 05:33:21 -05:00
saavagebueno commented 2025-11-20 05:33:21 -05:00
Author
Owner
Copy Link

@bc547 commented on GitHub (May 27, 2025):

This would be a very handy feature! Especially with lots of policies, it is a lot of work currently.

Afaik, the API does support renaming already and it's mainly the dashboard that is missing the UI part? (e.g. Settings->Groups)

@bc547 commented on GitHub (May 27, 2025): This would be a very handy feature! Especially with lots of policies, it is a lot of work currently. Afaik, the API does support renaming already and it's mainly the dashboard that is missing the UI part? (e.g. Settings->Groups)
saavagebueno commented 2025-11-20 05:33:21 -05:00
Author
Owner
Copy Link

@MichalisDBA commented on GitHub (Jun 2, 2025):

Any news about this?

@MichalisDBA commented on GitHub (Jun 2, 2025): Any news about this?
saavagebueno commented 2025-11-20 05:33:22 -05:00
Author
Owner
Copy Link

@mlsmaycon commented on GitHub (Jun 2, 2025):

Hello Folks, early in Q3/2025, we plan to move the group management to a higher level in our dashboard, perhaps replacing setup keys, and then you should be able to rename the groups.

For now, you should be able to use the API to rename, as pointed out by @bc547

@mlsmaycon commented on GitHub (Jun 2, 2025): Hello Folks, early in Q3/2025, we plan to move the group management to a higher level in our dashboard, perhaps replacing setup keys, and then you should be able to rename the groups. For now, you should be able to use the API to rename, as pointed out by @bc547
saavagebueno commented 2025-11-20 05:33:22 -05:00
Author
Owner
Copy Link

@hrvoj3e commented on GitHub (Sep 30, 2025):

I tried the API and to update the name but after that it removed itself from all the peers.
I have a selfhosted Netbird.

Is this a bug or intended?

❯ curl -X PUT https://my-netbird/api/groups/d3dpv47k31bs73abamjg \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Token nbp_fCb*************' \
      --data-raw '{
    "name": "my-cloud-network"
  }'

{"id":"d3dpv47k31bs73abamjg","issued":"api","name":"my-cloud-network","peers":null,"peers_count":0,"resources":null,"resources_count":0}
@hrvoj3e commented on GitHub (Sep 30, 2025): I tried the API and to update the name but after that it removed itself from all the peers. I have a selfhosted Netbird. Is this a bug or intended? ```shell ❯ curl -X PUT https://my-netbird/api/groups/d3dpv47k31bs73abamjg \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Token nbp_fCb*************' \ --data-raw '{ "name": "my-cloud-network" }' {"id":"d3dpv47k31bs73abamjg","issued":"api","name":"my-cloud-network","peers":null,"peers_count":0,"resources":null,"resources_count":0} ```
saavagebueno commented 2025-11-20 05:33:22 -05:00
Author
Owner
Copy Link

@nazarewk commented on GitHub (Sep 30, 2025):

@hrvoj3e I'm like 90% sure this endpoint is for a full update of the Group (not a partial update/patch), meaning you need to pass the whole object to it, not just a different group name, otherwise it gets cleared.

@nazarewk commented on GitHub (Sep 30, 2025): @hrvoj3e I'm like 90% sure [this endpoint](https://github.com/netbirdio/netbird/blob/e8d301fdc9357b9ca9ecf9ce40d4d347255d3bf9/management/server/http/handlers/groups/groups_handler.go#L121-L126) is for a full update of the Group (not a partial update/patch), meaning you need to pass the whole object to it, not just a different group name, otherwise it gets cleared.
saavagebueno commented 2025-11-20 05:33:22 -05:00
Author
Owner
Copy Link

@mitchplze commented on GitHub (Oct 16, 2025):

@hrvoj3e I'm like 90% sure this endpoint is for a full update of the Group (not a partial update/patch), meaning you need to pass the whole object to it, not just a different group name, otherwise it gets cleared.

@nazarewk: That doesn't seem to work for me either:

TOKEN=xxx
MGMT_URL=https://selfhostedurl.com
clear

# get groups
curl -X GET $MGMT_URL/api/groups \
-H "Accept: application/json" \
-H "Authorization: Token $TOKEN" | jq 

# relevant group output
# {
    # "id": "d3oprnce3knc73dkmbbg",
    # "issued": "api",
    # "name": "Test B",
    # "peers": [
      # {
        # "id": "d3mntjse3knc73e0c7bg",
        # "name": "mitch-macbook"
      # }
    # ],
    # "peers_count": 1,
    # "resources": null,
    # "resources_count": 0
#   }

# set group ID to rename
UPD_GROUP=d3oprnce3knc73dkmbbg

# tried to update it to "Test 3", including sending all peers
curl -X PUT $MGMT_URL/api/groups/$UPD_GROUP \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Token $TOKEN" \
--data-raw '{
  "name": "Test C",
  "peers": [
      {
        "id": "d3mntjse3knc73e0c7bg",
        "name": "mitch-macbook"
      }
    ],
}'

Produces:

{"message":"couldn't parse JSON request","code":400}

I even tried with the other null/empty fields that I believe are auto-generated:

curl -X PUT $MGMT_URL/api/groups/$UPD_GROUP \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Token $TOKEN" \
--data-raw '{
  "name": "Test C",
  "peers": [
      {
        "id": "d3mntjse3knc73e0c7bg",
        "name": "mitch-macbook"
      }
    ],
    "peers_count": 1,
    "resources": null,
    "resources_count": 0
}'

And it produces the same {"message":"couldn't parse JSON request","code":400}

@mitchplze commented on GitHub (Oct 16, 2025): > [@hrvoj3e](https://github.com/hrvoj3e) I'm like 90% sure [this endpoint](https://github.com/netbirdio/netbird/blob/e8d301fdc9357b9ca9ecf9ce40d4d347255d3bf9/management/server/http/handlers/groups/groups_handler.go#L121-L126) is for a full update of the Group (not a partial update/patch), meaning you need to pass the whole object to it, not just a different group name, otherwise it gets cleared. @nazarewk: That doesn't seem to work for me either: ```bash TOKEN=xxx MGMT_URL=https://selfhostedurl.com clear # get groups curl -X GET $MGMT_URL/api/groups \ -H "Accept: application/json" \ -H "Authorization: Token $TOKEN" | jq # relevant group output # { # "id": "d3oprnce3knc73dkmbbg", # "issued": "api", # "name": "Test B", # "peers": [ # { # "id": "d3mntjse3knc73e0c7bg", # "name": "mitch-macbook" # } # ], # "peers_count": 1, # "resources": null, # "resources_count": 0 # } # set group ID to rename UPD_GROUP=d3oprnce3knc73dkmbbg # tried to update it to "Test 3", including sending all peers curl -X PUT $MGMT_URL/api/groups/$UPD_GROUP \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Token $TOKEN" \ --data-raw '{ "name": "Test C", "peers": [ { "id": "d3mntjse3knc73e0c7bg", "name": "mitch-macbook" } ], }' ``` Produces: `{"message":"couldn't parse JSON request","code":400}` I even tried with the other null/empty fields that I believe are auto-generated: ```bash curl -X PUT $MGMT_URL/api/groups/$UPD_GROUP \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Token $TOKEN" \ --data-raw '{ "name": "Test C", "peers": [ { "id": "d3mntjse3knc73e0c7bg", "name": "mitch-macbook" } ], "peers_count": 1, "resources": null, "resources_count": 0 }' ``` And it produces the same `{"message":"couldn't parse JSON request","code":400}`
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label dashboard feature-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#1589
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?