APIs.io Engineering Platform · Schema
CreateUsagePlanRequest
The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| name | object | |
| description | object | |
| apiStages | object | |
| throttle | object | |
| quota | object | |
| tags | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreateUsagePlanRequest",
"title": "CreateUsagePlanRequest",
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The name of the usage plan."
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The description of the usage plan."
}
]
},
"apiStages": {
"allOf": [
{
"$ref": "#/components/schemas/ListOfApiStage"
},
{
"description": "The associated API stages of the usage plan."
}
]
},
"throttle": {
"allOf": [
{
"$ref": "#/components/schemas/ThrottleSettings"
},
{
"description": "The throttling limits of the usage plan."
}
]
},
"quota": {
"allOf": [
{
"$ref": "#/components/schemas/QuotaSettings"
},
{
"description": "The quota of the usage plan."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfStringToString"
},
{
"description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."
}
]
}
},
"description": "The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload."
}