Skip to content

Delete Group

Endpoint: DELETE /api/groups/{id}

Deletes a group permanently from the Conductor cluster. The invoking user must be an Admin to the Conductor cluster.

Path parameters

Parameter Description Type Required/ Optional
id The name of the group to delete. string Required.

Response

  • Returns 200 OK, with a message that the group has been deleted.
  • Returns 404 if an invalid group ID is provided.
  • Returns 403 if a non-admin invokes the API.

Examples

Delete a group

Request

curl -X 'DELETE' \
  'https://<YOUR-SERVER-URL>/api/groups/Writers' \
  -H 'accept: application/json' \
  -H 'X-Authorization: <TOKEN>'

Response

{
  "message": "Deleted group 'Writers'"
}