Throttling Tier (Collection)


Get available tiers

GET https://apis.wso2.com/api/am/store/v0.13/tiers/{tierLevel}

This operation can be used to retrieve all the tiers available for the provided tier level. Tier level should be specified as a path parameter and should be one of `api` and `application`. `X-WSO2-Tenant` header can be used to retrive tiers that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE**: * API tiers are the ones that is available during subscription of an application to an API. Hence they are also called subscription tiers and are same as the subscription policies in Admin REST API.

OAuth 2.0 Scope

Not required

Request

GET https://localhost:9443/api/am/store/v0.13/tiers/api

Response

HTTP/1.1 200 OK Content-Type: application/json { "previous": "", "list": [ { "unitTime": 60000, "tierPlan": "FREE", "stopOnQuotaReach": true, "tierLevel": "api", "requestCount": 1, "description": "Allows 1 request(s) per minute.", "name": "Bronze", "attributes": {} }, { "unitTime": 60000, "tierPlan": "FREE", "stopOnQuotaReach": true, "tierLevel": "api", "requestCount": 20, "description": "Allows 20 request(s) per minute.", "name": "Gold", "attributes": {} }, { "unitTime": 60000, "tierPlan": "FREE", "stopOnQuotaReach": true, "tierLevel": "api", "requestCount": 5, "description": "Allows 5 request(s) per minute.", "name": "Silver", "attributes": {} }, { "unitTime": 0, "tierPlan": null, "stopOnQuotaReach": true, "tierLevel": "api", "requestCount": 0, "description": "Allows unlimited requests", "name": "Unlimited", "attributes": {} } ], "count": 4, "next": "" }

Sample CURL

curl "https://localhost:9443/api/am/store/v0.13/tiers/api"

Sample CURL - for tenant

curl -k -H "X-WSO2-Tenant:test.com" https://localhost:9443/api/am/store/v0.13/tiers/api

Parameters

Type Name Description Schema Default
Path

tierLevel

required

List API or Application type tiers.

Accepted values:

api application
String

Query

limit

optional

Maximum size of resource array to return.

Integer

25

Query

offset

optional

Starting point within the complete list of items qualified.

Integer

0

Header

X-WSO2-Tenant

optional

For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from.

String

Header

Accept

optional

Media types acceptable for the response. Default is application/json.

String

application/json

Header

If-None-Match

optional

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

String

Responses

HTTP Code Description Schema

200

OK. List of tiers returned.

TierList

304

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

406

Not Acceptable. The requested media type is not supported

Error