Update a group with PUT /api/groups/:id and delete it with DELETE /api/groups/:id. They need the group:update and group:delete permissions. Look up the group's id with GET /api/groups first. Check the Groups page afterwards to see the result.
Steps
- Your role needs
group:updatefor edits, orgroup:deletefor removal. Both show on the API Reference rows. - Call
GET /api/groupswith your Bearer token, which lists each group with its member profiles. Copy the id of the one you want. - To change a group, send
PUT /api/groups/:id. Include the name, the description and the full membership you want it to hold, whether chosen by tag, by explicit profiles or by both, because the call replaces what was there before. - To remove a group, send
DELETE /api/groups/:id. - Go to Groups in the sidebar and reload the page. The list should match what you sent, with the right name, description and member count.
The Groups page we reviewed was empty, so we did not see edit or delete controls on a row. If your page shows them, they do the same job. Use whichever you prefer.
Good to know
Groups scope access, so a change here can alter what other people can reach. A token carries its owner's group scope. Remove a group that gave someone access to a profile, and their next call or CI job can start to fail without any other warning.
| Call | Purpose | Permission |
|---|---|---|
GET /api/groups | List groups with member profiles | group:read |
PUT /api/groups/:id | Update a group | group:update |
DELETE /api/groups/:id | Delete a group | group:delete |
- The call descriptions do not say that deleting a group deletes its profiles. Check the profile list afterwards.
- If a pipeline fails after a change, read why CI cannot access a profile.
- New group? See how to create one.
Keep groups tight, in line with least privilege.
Related questions
- How do I create a group of scan profiles?
- How do I add all profiles with a certain tag to a group?
- What are groups used for?
- Can I give someone access to only some of our targets?
- How do I delete a tag?
How to group scan profiles by tag and group in Cyberlop
Step-by-step, with annotated screenshots.
Updated · Back to the help centre
Still stuck?
Tell us what you see on screen and an engineer will help you sort it out.