x-apigateway-ratelimits.policy.special
Meaning: Definition of a special request throttling policy.
Scope of effect: x-apigateway-ratelimits.policy
Example:
x-apigateway-ratelimits:customRatelimitName:api-limit: 200app-limit: 200user-limit: 200ip-limit: 200interval: 1unit: MINUTEshared: falsespecial:- type: USERlimit: 100instance: xxxxxxxx
Parameter | Mandatory | Type | Description |
---|---|---|---|
type | Yes | String | Special request throttling policy type, which can be APP or USER. |
limit | Yes | Number | Access limit. |
instance | Yes | String | ID of an excluded app or user. |
Parent topic: API Design File Extension Definitions