Groups

Delete a group

DELETE/groups/{id}
groups:writedelete_groupDestructiveIdempotent

Deletes the group and returns 204. Its members are left as they are. A group that still has child groups returns 409 conflict: move or delete them first. Only super admin and multi-accounts may delete a group with a personal token; others get 403 missing_permission. A token that acts as its own service identity needs only the groups:write scope. It has no dry run. Emits group.deleted; no emails or notifications are sent. It can't be undone.

Path parameters

  • idstring (uuid)Required#

    The group's id, a uuid. An unknown group, or one your organisations cannot see, returns 404.

Responses

204

The group was deleted.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is missing_permission when the caller is not a super admin or multi-accounts manager, with those permissions in details, or one of missing_scope, scope_disabled, org_disabled, ip_blocked, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/groups/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"