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

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


Getting details of cartridges via the CLI

CLI command
DescriptionList all the available cartridges (single-tenant and multi-tenant).

List the cartridges that are currently available.

Sample output
Cartridges found:
| Type       | Category  | Name          | Description             | Version | Multi-Tenant |
| wso2am-190 | framework | WSO2 AM 1.9.0 | WSO2 AM 1.9.0 Cartridge | 1.9.0   | true         |

Getting details of cartridges via the REST API

DescriptionList all the available cartridges (single tenant and multi-tenant).
Resource Path


Request/Response Format


Command format
curl -X GET -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/cartridges
  • 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.

List the cartridges that are currently available.

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridges
Sample output
> GET /api/cartridges 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 08:15:55 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
[{"category":"framework","description":"WSO2 AM 1.9.0 Cartridge","displayName":"WSO2 AM 1.9.0","host":"","iaasProvider":[{"imageId":"wso2\/am:1.9.0","type":"mock"}],"loadBalancingIPType":"public","multiTenant":true,"portMapping":[{"kubernetesPortType":"NodePort","name":"mgt-https","port":9443,"protocol":"https","proxyPort":0},{"kubernetesPortType":"NodePort","name":"mgt-http","port":9763,"protocol":"http","proxyPort":0},{"kubernetesPortType":"NodePort","name":"pt-http","port":8280,"protocol":"http","proxyPort":0},{"kubernetesPortType":"NodePort","name":"pt-https","port":8243,"protocol":"https","proxyPort":0}],"provider":"wso2","type":"wso2am-190","version":"1.9.0"}]

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

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.



  • No labels