This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • 4.1.x Deleting a Deployment Policy via REST API
Skip to end of metadata
Go to start of metadata

Overview

Description

Delete a deployment policy.

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.

Resource Path

/deploymentPolicies/{deploymentPolicyId}

HTTP MethodDELETE
Request/Response Formatapplication/json
> DELETE /api/deploymentPolicies/deployment-policy-1 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 200 OK
< Date: Tue, 24 Mar 2015 07:55:10 GMT
< Location: https://localhost:9443/api/deploymentPolicies/deployment-policy-1/deployment-policy-1
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"status":"success","message":"Deployment policy removed successfully: [deployment-policy-id] deployment-policy-1"}
curl -X DELETE -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/deploymentPolicies/{deploymentPolicyId}

  • 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 DELETE -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/deploymentPolicies/deployment-policy-1 
 
CLI command

remove-deployment-policy

Description

Delete a deployment policy.

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.

Command format

remove-deployment-policy <DEPLOYMENT_POLICY_ID>


REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

  • No labels