This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Getting Details of Cartridge Groups - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You can get details of the cartridge groups in Private PaaS using the CLI tool or REST API as shown below:


Getting details of cartridge groups via the CLI

CLI command


DescriptionList all the available cartridge groups.

List the cartridge groups that are currently available in Private PaaS

Sample output
Cartridge Groups found:
| Name                            | No. of cartridges | No of groups |
| keymanager-gw-manager-gw-worker | 3                 | 0            |

Getting details of cartridge groups via the REST API

DescriptionRetrieve details of all the cartridge groups that have been added.
Resource PathcartridgeGroups
Request/Response Formatapplication/json
Command format
curl -X GET -H "Content-Type: application/json" -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_SAMPLES>/wso2am/1.9.0/samples/cartridge-groups/wso2am-190/wso2am-190-group1.json file.

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridgeGroups
Sample output
> GET /api/cartridgeGroups 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:12:29 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server

You will come across the following HTTP status codes while getting the details of the cartridge groups in Private PaaS:

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.



  • No labels