WSO2 · JSON Structure

Admin Api Ip Condition Structure

IPCondition schema from WSO2 API Manager

Type: object Properties: 4
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

IP based throttling condition is a JSON Structure definition published by WSO2, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ipConditionType specificIP startingIP endingIP

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-ip-condition-structure.json",
  "name": "IP based throttling condition",
  "description": "IPCondition schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "ipConditionType": {
      "type": "string",
      "description": "Type of the IP condition. Allowed values are \"IPRANGE\" and \"IPSPECIFIC\"",
      "enum": [
        "IPRANGE",
        "IPSPECIFIC"
      ]
    },
    "specificIP": {
      "type": "string",
      "description": "Specific IP when \"IPSPECIFIC\" is used as the ipConditionType"
    },
    "startingIP": {
      "type": "string",
      "description": "Staring IP when \"IPRANGE\" is used as the ipConditionType"
    },
    "endingIP": {
      "type": "string",
      "description": "Ending IP when \"IPRANGE\" is used as the ipConditionType"
    }
  }
}