Overview

Description

Forcefully undeploy an application. This will remove the entire runtime of the specified application. Forceful termination can be invoked even without invoking graceful undeployment.

Resource Path

/applications/{applicationId}/undeploy?force=true

HTTP MethodPOST
Request/Response Format

application/json

> POST /api/applications/single-cartridge-app/undeploy?force=true HTTP/1.1
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
>
< HTTP/1.1 202 Accepted
< Date: Wed, 08 Apr 2015 05:30:07 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"status":"success","message":"Application undeployed successfully: [application] single-cartridge-app"} 
curl -X POST -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/applications/{applicationId}/undeploy?force=true

  • By default, <STRATOS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <STRATOS_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.

For example:

curl -X POST -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/applications/single-cartridge-app/undeploy?force=true

REST API response

HTTP status code

202, 500

See the descriptions of the HTTP status codes here.

  • No labels