This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Deleting a Cartridge Group - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You can delete a cartridge group using the CLI tool, REST API or the PPaaS Console as shown below:


Delete a cartridge group via the CLI

CLI commandremove-cartridge-group
DescriptionDelete a cartridge group.
Command format

remove-cartridge-group <CARTRIDGE_GROUP_NAME>

Parameter definition
Short optionLong optionDescriptionRequiredExample value


N/ADefined name of the cartridge groupyes



Remove a cartridge group named keymanager-gw-manager-gw-worker.

remove-cartridge-group keymanager-gw-manager-gw-worker
Sample output
Cartridge Group deleted successfully: [cartridge-group] keymanager-gw-manager-gw-worker

Delete a cartridge group via the REST API

DescriptionDelete a cartridge group.
Resource Path


Request/Response Format


Command format
curl -X DELETE -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/cartridgeGroups/{groupDefinitionName}
  • By default, <USERNAME>:<PASSWORD> is admin:admin.
  • By default, <PRIVATE_PAAS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <PRIVATE_PAAS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Remove a cartridge group named keymanager-gw-manager-gw-worker.

curl -X DELETE -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridgeGroups/keymanager-gw-manager-gw-worker
Sample output
> DELETE /api/cartridgeGroups/keymanager-gw-manager-gw-worker HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
< HTTP/1.1 200 OK
< Date: Wed, 07 Oct 2015 06:43:44 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
{"status":"success","message":"Cartridge Group deleted successfully: [cartridge-group] keymanager-gw-manager-gw-worker"}

You will come across the following HTTP status codes while deleting a cartridge group:

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Delete a cartridge group via the PPaaS Console

Follow the instructions below to delete a cartridge group:

  1. Click Configurations on the home page.
  2. Click Cartridge Groups. The Cartridge Group Definitions page will appear.
  3. Hover your mouse pointer over the cartridge group, which you wish to delete, for the Delete button to appear and click Delete.
  4. Click Yes to delete the cartridge group.



  • No labels