This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Page Comparison - Updating an Application Policy (v.8 vs v.9) - WSO2 Private PaaS 4.1.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can update an application policy using the CLI tool, REST API or the Private PaaS console (UI) Console as shown below:

 

Localtab Group
Localtab
activetrue
titleCLI
Update

Updating an application policy via the CLI

Overview
CLI command
update-application-policy
DescriptionUpdate an application policy.
Command format
Code Block
update-application-policy -p <JSON_FILE_PATH>
Info

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

Parameter definition
Short optionLong optionDescriptionRequiredExample value
-p
--resource-pathFolder path where the JSON file that defines the application policy is stored.yes
<PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/
application-policies/mock/application-policy-1.json
Example

Update the application policy defined in the <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/application-policies/mock/application-policy-1.json file.

Code Block
update-application-policy -p <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/cartridge-groups/wso2am-190/wso2am-190-group1.json
Sample output
Code Block
Application policy updated successfully: [application-policy] application-policy-1
Localtab
titleREST API
Update

Updating an application policy via the REST API

Overview
DescriptionUpdate an application policy definition.
Resource Path/applicationPolicies
HTTP MethodPUT
Request/Response Formatapplication/json
Command format
Code Block
curl -X PUT -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/applicationPolicies
Info
  • The path to the JSON file that defines the application policy needs to be defined as the <JSON_PAYLOAD> value.
  • 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

Update a cartridge group that has been defined in the <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/application-policies/mock/application-policy-1.json file.

Code Block
cd <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples
curl -X PUT -H "Content-Type: application/json" -d @'application-policies/mock/application-policy-1.json' -k -v -u admin:admin https://localhost:9443/api/applicationPolicies
Sample output
Code Block
> PUT /api/applicationPolicies HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Content-Length: 160
> 
< HTTP/1.1 200 OK
< Date: Thu, 08 Oct 2015 05:59:13 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"status":"success","message":"Application policy updated successfully: [application-policy] application-policy-1"}

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

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Location header URL https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/ applicationPolicies /<APPLICATION_POLICY_ID>
Localtab
titlePrivate PaaS console
Update

Updating an application policy via the Private PaaS

console

Console

Updating an application policy via the UI editor

Follow the instructions below to view the details of an application policy:

  1. Click Configurations on the home page.
    Image Added
  2. Click Application Policies.
    Image Added
  3. Hover your mouse pointer over the application policy that you wish to update for the Edit button to appear and click Edit.
  4. Update the application policy definition as required. For property definitions, see the Application Policy Resource Definition.
    Image Added
  5. Click SAVE APPLICATION POLICY DEFINITION.

Updating an application policy via the JSON editor

Follow the instructions below to view the details of an application policy:

  1. Click Configurations on the home page.
    Image Added
  2. Click Application Policies. The Application Policy Definitions page will appear.
    Image Added
  3. Hover your mouse pointer over the application policy that you wish to update for the Edit button to appear and click Edit.
  4. Click on the editor control to switch to the JSON editor.
    Image Added
  5. Optionally, check the Auto correct with schema option to ensure that you do not accidentally delete any mandatory fields from the application policy definition JSON code.
    Image Added 
  6. Update the application policy definition as required For property definitions, see the Application Policy Resource Definition.
  7. Click SAVE APPLICATION POLICY DEFINITION.

 

...

 

Excerpt Include
Adding an Application Policy
Adding an Application Policy
nopaneltrue