Getting Details of Applications

You can get details of applications using the CLI tool or REST API as shown below:

Getting details of applications via the CLI

Overview

CLI command	`list-applications`
Description	Retrieve details of all the applications.

Example

Retrieve details of all the applications.

list-applications

Sample output

Applications found:
+------------------------+------------------------+---------+
| Application ID         | Alias                  | Status  |
+------------------------+------------------------+---------+
| wso2am-190-application | wso2am-190-application | Created |
+------------------------+------------------------+---------+

Getting details of applications via the REST API

Overview

Description	Retrieve details of all the applications that have been created.
Resource Path	`/applications`
HTTP Method	`GET`
Request/Response Format	`application/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/applications 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

Retrieve details of all the applications.

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/applications

Sample output

> GET /api/applications 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: Thu, 08 Oct 2015 11:20:34 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
[{"alias":"wso2am-190-application","applicationId":"wso2am-190-application","components":{"dependencies":{"startupOrders":[{"aliases":["group.keymanager-gw-manager-gw-worker","group.pub-store-grp"]}],"terminationBehaviour":"terminate-none"},"groups":[{"alias":"keymanager-gw-manager-gw-worker","cartridges":[{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"gateway-manager","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-gw-manager"},{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"gateway-worker","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-gw-worker"},{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"key-manager","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-km"}],"groupMaxInstances":1,"groupMinInstances":1,"name":"keymanager-gw-manager-gw-worker"},{"alias":"pub-store-grp","cartridges":[{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"publisher","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-pub"},{"cartridgeMax":1,"cartridgeMin":1,"subscribableInfo":{"alias":"store","autoscalingPolicy":"autoscaling-policy-1","deploymentPolicy":"deployment-policy-1","maxMembers":0,"minMembers":0},"type":"wso2am-190-store"}],"groupMaxInstances":1,"groupMinInstances":1,"name":"pub-store-grp"}]},"multiTenant":true,"signUpsExist":false,"status":"Created"}]

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

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.