Page Comparison

You can get details of a cartridge using the CLI tool, REST API or the management console (UI) as shown below:

Localtabgroup

Localtab

active	true
title	CLI

Get details of a cartridge via the CLI

Overview

CLI command	describe-cartridge
Description	Retrieve details of a specific cartridge.
Command format	describe-cartridge <CARTRIDGE_TYPE>

Parameter definition

Short option	Long option	Description	Required	Example value
N/A	N/A	Type of the cartridge	Yes	wso2am-190

Example

Retrieving the details of the cartridge with the type: wso2am-190.

Code Block
describe-cartridge wso2am-190

Sample output

Code Block

describe-cartridgewso2am-190{
  "type": "wso2am-190",
  "provider": "wso2",
  "category": "framework",
  "host": "am.wso2.org",
  "displayName": "WSO2 AM 1.9.0",
  "description": "WSO2 AM 1.9.0 Cartridge",
  "version": "1.9.0",
  "multiTenant": true,
  "portMapping": [
    {
      "name": "mgt-https",
      "protocol": "https",
      "port": 9443,
      "proxyPort": 0,
      "kubernetesPortType": "NodePort"
    },
    {
      "name": "mgt-http",
      "protocol": "http",
      "port": 9763,
      "proxyPort": 0,
      "kubernetesPortType": "NodePort"
    },
    {
      "name": "pt-http",
      "protocol": "http",
      "port": 8280,
      "proxyPort": 0,
      "kubernetesPortType": "NodePort"
    },
    {
      "name": "pt-https",
      "protocol": "https",
      "port": 8243,
      "proxyPort": 0,
      "kubernetesPortType": "NodePort"
    }
  ],
  "iaasProvider": [
    {
      "type": "mock",
      "imageId": "wso2/am:1.9.0"
    }
  ],
  "loadBalancingIPType": "public"
}

Localtab

title	REST API

Get details of a cartridge via the REST API

Overview

Description Retrieve details of a specific cartridge.

Resource Path

/cartridges/{cartridgeType}

HTTP Method GET

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/{cartridgeType}

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

Retrieving the details of the cartridge with the type: wso2am-190.

Code Block
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridges/wso2am-190

Sample output

Code Block

> GET /api/cartridges/wso2am-190 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 09:42:14 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 a cartridge:

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Localtab

title	Management console

Get details of a cartridge via the management console

...

Versions Compared

Old Version 1

New Version 2

Key

Get details of a cartridge via the CLI

Overview

Parameter definition

Example

Sample output

Get details of a cartridge via the REST API

Overview

Example

Sample output

Get details of a cartridge via the management console