AdvancedPoliciesApi


Get all Advanced level throttle policies

Get all Advanced level throttle policies\n

URL

https://apis.wso2.com/api/am/admin/v0.10/throttling/policies/advanced

HTTP Method

GET

Scope

apim:tier_view

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Header

Accept

optional

Media types acceptable for the response. Default is JSON.\n

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved\nvariant of the resourec.\n

String

Header

If-Modified-Since

optional

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

String

Responses

HTTP Code Description Schema

200

OK.\nPolicies returned\n

AdvancedThrottlePolicyList

304

Not Modified.\nEmpty body because the client has already the latest version of the requested resource.\n

406

Not Acceptable.\nThe requested media type is not supported.\n

Error

Delete an Advanced level throttle policy

Delete an Advanced level throttle policy\n

URL

https://apis.wso2.com/api/am/admin/v0.10/throttling/policies/advanced/{policyId}

HTTP Method

DELETE

Scope

apim:tier_manage

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Path

policyId

required

Thorttle policy UUID\n

String

Header

If-Match

optional

Validator for conditional requests; based on ETag.\n

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.\n

String

Responses

HTTP Code Description Schema

200

OK.\nResource successfully deleted.\n

404

Not Found.\nResource to be deleted does not exist.\n

Error

412

Precondition Failed.\nThe request has not been performed because one of the preconditions is not met.\n

Error

Retrieve an Advanced Policy

Retrieve a Advanced Policy providing the policy name.\n

URL

https://apis.wso2.com/api/am/admin/v0.10/throttling/policies/advanced/{policyId}

HTTP Method

GET

Scope

apim:tier_view

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Path

policyId

required

Thorttle policy UUID\n

String

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved\nvariant of the resourec.\n

String

Header

If-Modified-Since

optional

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

String

Responses

HTTP Code Description Schema

200

OK.\nPolicy returned\n

AdvancedThrottlePolicy

304

Not Modified.\nEmpty body because the client has already the latest version of the requested resource.\n

404

Not Found.\nRequested Policy does not exist.\n

Error

406

Not Acceptable.\nThe requested media type is not supported.\n

Error

Update an Advanced level throttle policy

Update an Advanced level throttle policy\n

URL

https://apis.wso2.com/api/am/admin/v0.10/throttling/policies/advanced/{policyId}

HTTP Method

PUT

Scope

apim:tier_manage

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Path

policyId

required

Thorttle policy UUID\n

String

Body

body

required

Policy object that needs to be modified\n

AdvancedThrottlePolicy (AdvancedThrottlePolicy)

Header

Content-Type

required

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

String

JSON

Header

If-Match

optional

Validator for conditional requests; based on ETag.\n

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on Last Modified header.\n

String

Responses

HTTP Code Description Schema

200

OK.\nPolicy updated.\n

AdvancedThrottlePolicy

400

Bad Request.\nInvalid request or validation error.\n

Error

404

Not Found.\nThe resource to be updated does not exist.\n

Error

412

Precondition Failed.\nThe request has not been performed because one of the preconditions is not met.\n

Error

Add an Advanced level throttle policy

Add an Advanced level throttle policy\n

URL

https://apis.wso2.com/api/am/admin/v0.10/throttling/policies/advanced

HTTP Method

POST

Scope

apim:tier_manage

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Body

body

required

Advanced level policy object that should to be added\n

AdvancedThrottlePolicy (AdvancedThrottlePolicy)

Header

Content-Type

required

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

String

JSON

Responses

HTTP Code Description Schema

201

Created.\nSuccessful response with the newly created object as entity in the body.\nLocation header contains URL of newly created entity.\n

AdvancedThrottlePolicy

400

Bad Request.\nInvalid request or validation error\n

Error

415

Unsupported media type.\nThe entity of the request was in a not supported format.\n