Deleting a Cartridge

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

Deleting a cartridge via the CLI

Overview

CLI command	remove-cartridge
Description	Delete a cartridge.
Command format	remove-cartridge <CARTRIDGE_TYPE>

Parameter definition

Short option	Long option	Description	Required	Example value
N/A	N/A	Type of the cartridge	Yes	wso2am-190

Example

Delete the cartridge with the type: wso2am-190.

remove-cartridge wso2am-190

Sample output

Cartridge deleted successfully: [cartridge-type] wso2am-190

Deleting a cartridge via the REST API

Overview

Description	Delete a cartridge.
Resource Path	`/cartridges/{cartridgeType}`
HTTP Method	`DELETE`
Request/Response Format	`application/json`
Command format	curl -X DELETE -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/cartridges/{cartridgeType} 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`.

Example

Delete the cartridge with the type: wso2am-190 .

curl -X DELETE -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridges/wso2am-190

Sample output

> DELETE /api/cartridges/wso2am-190 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: Tue, 06 Oct 2015 09:59:12 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"status":"success","message":"Cartridge deleted successfully: [cartridge-type] wso2am-190"}

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

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Deleting a cartridge via the PPaaS Console

Follow the instructions below to delete a cartridge:

Click Configurations on the home page.
Click Cartridges. The Cartridges page will appear.
Hover your mouse pointer over the cartridge, which you wish to delete, for the Delete button to appear and click Delete.
Click Yes to delete the cartridge.