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

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


Getting details of a cartridge group via the CLI

CLI commanddescribe-cartridge-group
DescriptionRetrieve details of a specific cartridge group.
Command formatdescribe-cartridge-group <CARTRIDGE_GROUP_NAME>
Parameter definition
Short optionLong optionDescriptionRequiredExample value


N/ADefined name of the cartridge groupyes



Retrieve details on the cartridge group named keymanager-gw-manager-gw-worker.

describe-cartridge-group keymanager-gw-manager-gw-worker
Sample output
ServiceGroup: keymanager-gw-manager-gw-worker
  "name": "keymanager-gw-manager-gw-worker",
  "cartridges": [
  "dependencies": {
    "terminationBehaviour": "terminate-none"

Getting details of a cartridge group via the REST API

DescriptionRetrieve details of a cartridge group.
Resource Path /cartridgeGroups/{groupDefinitionName}
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/{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.

Retrieve details on the cartridge group named keymanager-gw-manager-gw-worker .

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridgeGroups/keymanager-gw-manager-gw-worker
Sample output
> GET /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:30:46 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 a cartridge group:

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Getting details of a cartridge group via the PPaaS Console

Follow the instructions below to view the details of a cartridge group:

  1. Click Configurations on the home page.
  2. Click Cartridge Groups.
  3. Hover your mouse pointer over the cartridge group, which you wish to view, for the Details button to appear and click Details.
    The cartridge group definition appears in the UI editor.

    If you wish to see the JSON schema of the selected cartridge group click on the toggle view to switch to the JSON view.
    The cartridge group definition appears in the JSON editor.



  • No labels