This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Undeploying an Application - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You can add an application using the CLI tool, REST API or the PPaaS Console as shown below:


Undeploying an application via the CLI

CLI commandundeploy-application
DescriptionUndeploy an application.
Command format
undeploy-application <APPLICATION_ID>
Parameter definition
Short optionLong optionDescriptionRequiredExample value
N/AN/AUnique ID of the applicationYeswso2am-190-application

Undeploy an application named wso2am-190-application.

undeploy-application wso2am-190-application
Sample output
Application undeploy process started successfully: [application-id] wso2am-190-application

Undeploying an application via the REST API

DescriptionUndeploy an application. This will remove the entire runtime of the specified application.
Resource Path


Request/Response Format


Command format
curl -X POST -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/applications/{applicationId}/undeploy
  • 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.

Undeploy an application named  wso2am-190-application .

curl -X POST -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/applications/wso2am-190-application/undeploy
Sample output
 > POST /api/applications/wso2am-190-application/undeploy HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
< HTTP/1.1 202 Accepted
< Date: Mon, 12 Oct 2015 06:08:56 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
{"status":"success","message":"Application undeploy process started successfully: [application-id] wso2am-190-application"}

You will come across the following HTTP status codes while undeploying an application:

HTTP status code

202, 500

See the descriptions of the HTTP status codes here.

Undeploying an application via the PPaaS Console

Follow the instructions below to undeploy an application:

  1. Click Applications on the home page.
  2. Hover your mouse pointer over the application that you wish to deploy for the Undeploy button to appear and click Undeploy.
  3. Click Yes to undeploy the application




  • No labels