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 Updating a Deployment Policy via REST API
Skip to end of metadata
Go to start of metadata

Overview

Description

Update a deployment policy definition.

Resource Path

/deploymentPolicies

HTTP MethodPUT
Request/Response Format

application/json

Sample request

The following properties can not be changed in the updating process:

  • id - Deployment policy ID.
  • id - Network partition ID.
  • id - Partition ID.

{
  "id": "deployment-policy-1",
  "networkPartitions": [
    {
      "id": "network-partition-1",
      "partitionAlgo": "one-after-another",
      "partitions": [
        {
          "id": "partition-1",
          "partitionMax": 20
        }
      ]
    }
  ]
}

For information on the property definitions, see the Deployment Policy Resource Definition.

> PUT /api/deploymentPolicies 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
> Content-Length: 281
>
* upload completely sent off: 281 out of 281 bytes
< HTTP/1.1 200 OK
< Date: Thu, 19 Mar 2015 09:27:06 GMT
< Location: https://localhost:9443/api/deploymentPolicies/deployment-policy-1
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"status":"success","message":"Deployment policy updated successfully: [deployment-policy-id] deployment-policy-1"}
curl -X PUT -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/deploymentPolicies
  • The path to the JSON file that defines the deployment policy needs to be defined as the <JSON_PAYLOAD> value.

  • 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:

cd <STRATOS_SOURCE_HOME>/samples
curl -X PUT -H "Content-Type: application/json" -d @'deployment-policies/deployment-policy-1.json' -k -v -u admin:admin https://localhost:9443/api/deploymentPolicies

CLI command
update-deployment-policy          
DescriptionUpdate a deployment policy.
Command format

update-deployment-policy -p <JSON_FILE_PATH>

The path to the JSON file that defines the deployment policy needs to be defined as the <JSON_FILE_PATH> value.


REST API response

HTTP status code

200, 500, 409
See the descriptions of the HTTP status codes here .

Location header URL

https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/deploymentPolicies/<DEPLOYMENT_POLICY_ID>

  • No labels