WSO2 · JSON Structure

Publisher Api Api Max Tps Structure

APIMaxTps schema from WSO2 API Manager

Type: object Properties: 5
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

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

Properties

production productionTimeUnit sandbox sandboxTimeUnit tokenBasedThrottlingConfiguration

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/publisher-api-api-max-tps-structure.json",
  "name": "APIMaxTps",
  "description": "APIMaxTps schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "production": {
      "type": "int64",
      "example": 1000
    },
    "productionTimeUnit": {
      "type": "string",
      "description": "Time unit for the production.",
      "default": "SECOND",
      "enum": [
        "SECOND",
        "MINUTE",
        "HOUR"
      ]
    },
    "sandbox": {
      "type": "int64",
      "example": 1000
    },
    "sandboxTimeUnit": {
      "type": "string",
      "description": "Time unit for the sandbox.",
      "default": "SECOND",
      "enum": [
        "SECOND",
        "MINUTE",
        "HOUR"
      ]
    },
    "tokenBasedThrottlingConfiguration": {
      "type": "object",
      "required": [
        "isTokenBasedThrottlingEnabled"
      ],
      "properties": {
        "productionMaxPromptTokenCount": {
          "type": "int64",
          "description": "Maximum prompt token count for production"
        },
        "productionMaxCompletionTokenCount": {
          "type": "int64",
          "description": "Maximum completion token count for production"
        },
        "productionMaxTotalTokenCount": {
          "type": "int64",
          "description": "Maximum total token count for production"
        },
        "sandboxMaxPromptTokenCount": {
          "type": "int64",
          "description": "Maximum prompt token count for sandbox"
        },
        "sandboxMaxCompletionTokenCount": {
          "type": "int64",
          "description": "Maximum completion token count for sandbox"
        },
        "sandboxMaxTotalTokenCount": {
          "type": "int64",
          "description": "Maximum total token count for sandbox"
        },
        "isTokenBasedThrottlingEnabled": {
          "type": "boolean",
          "default": false,
          "description": "Whether token-based throttling is enabled"
        }
      }
    }
  }
}