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 Adding an Application Policy via REST API
Skip to end of metadata
Go to start of metadata

Overview

DescriptionAdd an application policy definition.
Resource Path/applicationPolicies
HTTP MethodPOST
Request/Response Formatapplication/json

Sample request

{
  "id": "application-policy-1",
  "algorithm": "one-after-another",
  "networkPartitions": [
    "network-partition-1"
  ],
  "properties": [
    {
      "name": "key-1",
      "value": "value-1"
    },
    {
      "name": "key-2",
      "value": "value-2"
    }
  ]
}

For information on all the properties that can be used in an application policy definition, see the Application Policy Resource Definition.

> POST /api/applicationPolicies 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: 307
>
* upload completely sent off: 307 out of 307 bytes
< HTTP/1.1 201 Created
< Date: Mon, 30 Mar 2015 11:42:52 GMT
< Location: https://localhost:9443/api/applicationPolicies/application-policy-1
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"status":"success","message":"Application policy added successfully: [application-policy] application-policy-1"}
curl -X POST -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/applicationPolicies
  • The path to the JSON file that defines the application 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:

curl -X POST -H "Content-Type: application/json" -d @'application-policies/application-policy-1.json' -k -v -u admin:admin https://localhost:9443/api/applicationPolicies
 
CLI command
add-application-policy      
DescriptionAdd an application policy.
Command format
add-application-policy -p <JSON_FILE_PATH>

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


REST API response

HTTP status code

201, 400, 409, 500

See the descriptions of the HTTP status codes here.

Location header URL

https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/applicationPolicies/<APPLICATION_POLICY_ID>

  • No labels