Page Comparison

...

Localtabgroup

Localtab

active	true
title	CLI

Deleting a deployment policy via the CLI

Overview

CLI command

remove-deployment-policy

Description

Delete a deployment policy.

Command format

Code Block
remove-deployment-policy <DEPLOYMENT_POLICY_ID>

Parameter definition

Short option	Long option	Description	Required	Example value
N/A	N/A	The ID of the deployment policy	Yes	`deployment-policy-1`

Example

Delete a deployment policy with the id: deployment-policy-1.

Code Block
remove-deployment-policy deployment-policy-1

Sample output

Code Block
Deployment policy removed successfully: [deployment-policy-id] deployment-policy-1

Localtab

title	REST API

Deleting a deployment policy via the REST API

Overview

Description

Delete a deployment policy.

Resource Path

/deploymentPolicies/{deploymentPolicyId}

HTTP Method DELETE

Request/Response Format application/json

Command format

Code Block
curl -X DELETE -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/deploymentPolicies/{deploymentPolicyId}

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

Delete a deployment policy with the id: deployment-policy-1.

Code Block
curl -X DELETE -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/deploymentPolicies/deployment-policy-1

Sample output

Code Block

> DELETE /api/deploymentPolicies/deployment-policy-1 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: Mon, 05 Oct 2015 06:23:44 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"status":"success","message":"Deployment policy removed successfully: [deployment-policy-id] deployment-policy-1"}

You will come across the following HTTP status codes while deleting a deployment policy:

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Localtab

title	Management consolePPaaS Console

Deleting a deployment policy via the PPaaS Console

Follow the instructions below to delete a deployment policy:

Note
You will not be allowed to delete deployment polices that are being used by deployed applications. If a deployment policy is being used by a deployed application, you will have to first undeploy the application to be able to delete the corresponding deployment policy.

Click Configurations on the home page.
Click Deployment Policies. The Deployment Policies page will appear.
Hover your mouse pointer over the deployment policy that you wish to delete for the Delete button to appear and click Delete.
Click Yes to delete the deployment policy.