Application Policies


Get all Application level throttle policies
GET https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application

Get all Application level throttle policies

OAuth 2.0 Scope

apim:tier_viewi

Request

GET https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Header

Accept

optional

Media types acceptable for the response. Default is JSON.

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec.

String

Header

If-Modified-Since

optional

Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK. Policies returned

ApplicationThrottlePolicyList

304

Not Modified. Empty body because the client has already the latest version of the requested resource.

406

Not Acceptable. The requested media type is not supported.

Error

Delete an Application level throttle policy
DELETE https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application/{policyId}

Delete an Application level throttle policy

OAuth 2.0 Scope

apim:tier_managei

Request

DELETE https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application/{policyId}

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Path

policyId

required

Thorttle policy UUID

String

Header

If-Match

optional

Validator for conditional requests; based on ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Resource successfully deleted.

404

Not Found. Resource to be deleted does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Retrieve an Application Policy
GET https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application/{policyId}

Retrieve an Application Policy providing the policy name.

OAuth 2.0 Scope

apim:tier_viewi

Request

GET https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application/{policyId}

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Path

policyId

required

Thorttle policy UUID

String

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec.

String

Header

If-Modified-Since

optional

Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK. Policy returned

ApplicationThrottlePolicy

304

Not Modified. Empty body because the client has already the latest version of the requested resource.

404

Not Found. Requested Tier does not exist.

Error

406

Not Acceptable. The requested media type is not supported.

Error

Update an Application level throttle policy
PUT https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application/{policyId}

Update an Application level throttle policy

OAuth 2.0 Scope

apim:tier_managei

Request

PUT https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application/{policyId}

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Path

policyId

required

Thorttle policy UUID

String

Body

body

required

Policy object that needs to be modified

ApplicationThrottlePolicy (ApplicationThrottlePolicy)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.

String

JSON

Header

If-Match

optional

Validator for conditional requests; based on ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Policy updated.

ApplicationThrottlePolicy

400

Bad Request. Invalid request or validation error.

Error

404

Not Found. The resource to be updated does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Add an Application level throttle policy
POST https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application

Add an Application level throttle policy

OAuth 2.0 Scope

apim:tier_managei

Request

POST https://apis.wso2.com/api/am/admin/v0.12/throttling/policies/application

Response

Not Available

Sample CURL

Not Available

Parameters

Type Name Description Schema Default
Body

body

required

Application level policy object that should to be added

ApplicationThrottlePolicy (ApplicationThrottlePolicy)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.

String

JSON

Responses

HTTP Code Description Schema

201

Created. Successful response with the newly created object as entity in the body. Location header contains URL of newly created entity.

ApplicationThrottlePolicy

400

Bad Request. Invalid request or validation error

Error

415

Unsupported media type. The entity of the request was in a not supported format.