This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Page Comparison - Getting Details of Cartridges (v.2 vs v.3) - WSO2 Private PaaS 4.1.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Localtab Group
Localtab
activetrue
titleCLI
Get

Getting details of cartridges via the CLI

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

List the cartridges that are currently available.

Code Block
list-cartridges
Sample output
Code Block
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         |
+------------+-----------+---------------+-------------------------+---------+--------------+
Localtab
titleREST API
Get

Getting details of cartridges via the REST API

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

/cartridges

HTTP MethodGET
Request/Response Format

application/json

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

List the cartridges that are currently available.

Code Block
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridges
Sample output
Code Block
> 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":"am.wso2.org","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.

...