POST

/usageplans

http://apigateway.{region}.amazonaws.com/usageplans

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Access Token Required: API Key

Body Params

namestringrequired

The name of the usage plan.

tagsobject

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.

quotaobject

Quotas configured for a usage plan.

throttleobject

The API request rate limits.

apiStagesarray

The associated API stages of the usage plan.

descriptionstring

The description of the usage plan.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://apigateway.{region}.amazonaws.com/usageplans' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}