WSO2 · JSON Structure

Admin Api Throttle Condition Structure

Conditions used for Throttling

Type: object Properties: 6 Required: 1
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Throttling Conditions is a JSON Structure definition published by WSO2, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type invertCondition headerCondition ipCondition jwtClaimsCondition queryParameterCondition

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/admin-api-throttle-condition-structure.json",
  "name": "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"
    }
  }
}