Subscription Policies (Individual)


Delete a Subscription level throttle policy
DELETE https://apis.wso2.com/api/am/admin/v0.11/throttling/policies/subscription/{policyId}

This operation can be used to delete a Subscription level throttle policy specifying the id of the policy as a path paramter.

OAuth 2.0 Scope

apim:tier_managei

Request

DELETE https://localhost:9443/api/am/admin/v0.11/throttling/policies/subscription/3cc8902e-f7c7-49dc-987b-b146e9bd8ee8 Authorization: Bearer 0d63e133-7ad6-3aeb-9ca9-9299e0708122 Content-Type: application/json

Response

HTTP/1.1 200 OK

Sample CURL

curl -k -X DELETE -H "Authorization: Bearer 0d63e133-7ad6-3aeb-9ca9-9299e0708122" -H "Content-Type: application/json" https://localhost:9443/api/am/admin/v0.11/throttling/policies/subscription/3cc8902e-f7c7-49dc-987b-b146e9bd8ee8

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 (Will be supported in future).

Error

Retrieve a Subscription Policy
GET https://apis.wso2.com/api/am/admin/v0.11/throttling/policies/subscription/{policyId}

This operation can be used to retrieve a single Subscription Policy providing the id of policy as a path parameter.

OAuth 2.0 Scope

apim:tier_viewi

Request

GET https://localhost:9443/api/am/admin/v0.11/throttling/policies/subscription/6dd9fc11-bbe1-4daf-aee5-06a4d0e44476 Authorization: Bearer 0d63e133-7ad6-3aeb-9ca9-9299e0708122

Response

HTTP/1.1 200 OK Content-Type: application/json { "policyId": "6dd9fc11-bbe1-4daf-aee5-06a4d0e44476", "policyName": "Platinum", "displayName": "Platinum", "description": "Allows 4000 requests per minute", "isDeployed": true, "defaultLimit": { "type": "RequestCountLimit", "timeUnit": "min", "unitTime": 1, "requestCount": 4000 }, "rateLimitCount": -1, "rateLimitTimeUnit": "NA", "customAttributes": [ { "name": "attr1", "value": "123" }, { "name": "attr2", "value": "12" } ], "stopOnQuotaReach": true, "billingPlan": "COMMERCIAL" }

Sample CURL

curl -k -H "Authorization: Bearer 0d63e133-7ad6-3aeb-9ca9-9299e0708122" https://localhost:9443/api/am/admin/v0.11/throttling/policies/subscription/6dd9fc11-bbe1-4daf-aee5-06a4d0e44476

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

SubscriptionThrottlePolicy

304

Not Modified. Empty body because the client has already the latest version of the requested resource (Will be supported in future).

404

Not Found. Requested Policy does not exist.

Error

406

Not Acceptable. The requested media type is not supported.

Error

Update a Subscription level throttle policy
PUT https://apis.wso2.com/api/am/admin/v0.11/throttling/policies/subscription/{policyId}

This operation can be used to update a Subscription level throttle policy.

OAuth 2.0 Scope

apim:tier_managei

Request

PUT https://localhost:9443/api/am/admin/v0.11/throttling/policies/subscription/6dd9fc11-bbe1-4daf-aee5-06a4d0e44476 Authorization: Bearer 0d63e133-7ad6-3aeb-9ca9-9299e0708122 Content-Type: application/json { "policyName": "Platinum", "displayName": "Platinum", "description": "Allows 10000 requests per minute", "defaultLimit": { "type": "RequestCountLimit", "timeUnit": "min", "unitTime": 1, "requestCount": 10000 }, "isDeployed": true, "rateLimitCount": -1, "rateLimitTimeUnit": "NA", "customAttributes": [ { "name": "attr", "value": "123" }, { "name": "attr1", "value": "456" } ], "stopOnQuotaReach": true, "billingPlan": "COMMERCIAL" }

Response

HTTP/1.1 200 OK Content-Type: application/json { "policyId": "6dd9fc11-bbe1-4daf-aee5-06a4d0e44476", "policyName": "Platinum", "displayName": "Platinum", "description": "Allows 10000 requests per minute", "isDeployed": true, "defaultLimit": { "type": "RequestCountLimit", "timeUnit": "min", "unitTime": 1, "requestCount": 10000 }, "rateLimitCount": -1, "rateLimitTimeUnit": "NA", "customAttributes": [ { "name": "attr", "value": "123" }, { "name": "attr1", "value": "456" } ], "stopOnQuotaReach": true, "billingPlan": "COMMERCIAL" }

Sample CURL

curl -k -X PUT -H "Authorization: Bearer 0d63e133-7ad6-3aeb-9ca9-9299e0708122" -H "Content-Type: application/json" https://localhost:9443/api/am/admin/v0.11/throttling/policies/subscription/6dd9fc11-bbe1-4daf-aee5-06a4d0e44476 -d @data.json

Parameters

Type Name Description Schema Default
Path

policyId

required

Thorttle policy UUID

String

Body

body

required

Policy object that needs to be modified

SubscriptionThrottlePolicy (SubscriptionThrottlePolicy)

Header

Content-Type

required

Media type of the entity in the body. Default is application/json.

String

application/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.

SubscriptionThrottlePolicy

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 (Will be supported in future).

Error