Throttling Tier (Collection)


Get all tiers

GET https://apis.wso2.com/api/am/publisher/v0.16/tiers/{tierLevel}

This operation can be used to list the available tiers for a given tier level. Tier level should be specified as a path parameter and should be one of `api`, `application` and `resource`.

OAuth 2.0 Scope

Not required

Examples

Parameters

Type Name Description Schema Default
Path

tierLevel

required

List API or Application or Resource type tiers.

Accepted values:

api application resource
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

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

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

Create a Tier

POST https://apis.wso2.com/api/am/publisher/v0.16/tiers/{tierLevel}

This operation can be used to create a new throttling tier. The only supported tier level is `api` tiers. `POST https://localhost:9443/api/am/publisher/v0.16/tiers/api` **IMPORTANT:** * This is only effective when Advanced Throttling is disabled in the Server. If enabled, we need to use Admin REST API for throttling tiers modification related operations.

OAuth 2.0 Scope

Not required

Examples

Parameters

Type Name Description Schema Default
Body

body

required

Tier object that should to be added

Tier (Tier)

Path

tierLevel

required

List API or Application or Resource type tiers.

Accepted values:

api
String

Header

Content-Type

required

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

String

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

Tier

400

Bad Request. Invalid request or validation error

Error

415

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