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

You can update a cartridge group using the REST API as shown below:

DescriptionUpdate a cartridge group definition.
Resource Path


Request/Response Format


Command format
curl -X PUT -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/cartridgeGroups
  • The path to the JSON file that defines the cartridge group needs to be defined as the <JSON_PAYLOAD> value.
  • 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.

Add a cartridge group that has been defined in the <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/cartridge-groups/wso2am-190/wso2am-190-group1.json file.

cd <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples
curl -X PUT -H "Content-Type: application/json" -d @'cartridge-groups/wso2am-190/wso2am-190-group1.json' -k -v -u admin:admin https://localhost:9443/api/cartridgeGroups
Sample output
> PUT /api/cartridgeGroups HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Content-Length: 233
* upload completely sent off: 233 out of 233 bytes
< HTTP/1.1 200 OK
< Date: Wed, 07 Oct 2015 05:53:55 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
* Connection #0 to host localhost left intact
{"status":"success","message":"Cartridge group updated successfully: [cartridge-group] keymanager-gw-manager-gw-worker"}

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

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Location header URLhttps://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/cartridgeGroups/<CARTRIDGE_TYPE>


Sample cartridge group JSON

  "name": "keymanager-gw-manager-gw-worker",
  "cartridges": [
  "dependencies": {
    "terminationBehaviour": "terminate-none"

  • No labels