WSO2 · Schema

Throttling Conditions

Conditions used for Throttling

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name Type Description
type string Type of the throttling condition. Allowed values are "HEADERCONDITION", "IPCONDITION", "JWTCLAIMSCONDITION" and "QUERYPARAMETERCONDITION".
invertCondition boolean Specifies whether inversion of the condition to be matched against the request. **Note:** When you add conditional groups for advanced throttling policies, this paramater should have the same value ('
headerCondition object
ipCondition object
jwtClaimsCondition object
queryParameterCondition object
View JSON Schema on GitHub

JSON Schema

admin-api-throttle-condition-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/admin-api-throttle-condition-schema.json",
  "title": "Throttling Conditions",
  "description": "Conditions used for Throttling",
  "required": [
    "type"
  ],
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of the throttling condition. Allowed values are \"HEADERCONDITION\", \"IPCONDITION\", \"JWTCLAIMSCONDITION\"\nand \"QUERYPARAMETERCONDITION\".\n",
      "enum": [
        "HEADERCONDITION",
        "IPCONDITION",
        "JWTCLAIMSCONDITION",
        "QUERYPARAMETERCONDITION"
      ]
    },
    "invertCondition": {
      "type": "boolean",
      "description": "Specifies whether inversion of the condition to be matched against the request.\n\n**Note:** When you add conditional groups for advanced throttling policies, this paramater should have the\nsame value ('true' or 'false') for the same type of conditional group.\n",
      "default": false
    },
    "headerCondition": {
      "$ref": "#/components/schemas/HeaderCondition"
    },
    "ipCondition": {
      "$ref": "#/components/schemas/IPCondition"
    },
    "jwtClaimsCondition": {
      "$ref": "#/components/schemas/JWTClaimsCondition"
    },
    "queryParameterCondition": {
      "$ref": "#/components/schemas/QueryParameterCondition"
    }
  }
}