Sign in

v1

latestOpenAPI 3.0.12026-07-17387979.8 KB
Subscription Validation

Get all API throttling policies

This will provide access to api level throttling policies in database.

get/api-policies

Query parameters

policyNamestring

Search condition. Api policy name

Headers

xWSO2Tenantstring required

This is used to specify the tenant domain, where the resource need to be retrieved from.

Response

An array of api policies in the database

countinteger

Number of Api Policies returned.

Example response

{
  "count": 1,
  "list": [
    {
      "conditionGroups": [
        {
          "defaultLimit": {
            "requestCount": {
              "timeUnit": "min",
              "unitTime": 10,
              "requestCount": 1000
            },
            "bandwidth": {
              "timeUnit": "min",
              "unitTime": 10,
              "dataAmount": 1000,
              "dataUnit": "KB"
            },
            "eventCount": {
              "timeUnit": "min",
              "unitTime": 10,
              "eventCount": 3000
            },
            "aiApiQuota": {
              "timeUnit": "min",
              "unitTime": 10,
              "requestCount": 1000,
              "totalTokenCount": 1000,
              "promptTokenCount": 300,
              "completionTokenCount": 300
            }
          }
        }
      ],
      "defaultLimit": {
        "requestCount": {
          "timeUnit": "min",
          "unitTime": 10,
          "requestCount": 1000
        },
        "bandwidth": {
          "timeUnit": "min",
          "unitTime": 10,
          "dataAmount": 1000,
          "dataUnit": "KB"
        },
        "eventCount": {
          "timeUnit": "min",
          "unitTime": 10,
          "eventCount": 3000
        },
        "aiApiQuota": {
          "timeUnit": "min",
          "unitTime": 10,
          "requestCount": 1000,
          "totalTokenCount": 1000,
          "promptTokenCount": 300,
          "completionTokenCount": 300
        }
      }
    }
  ],
  "pagination": {
    "limit": 1,
    "total": 10
  }
}