This is the multi-page printable view of this section. Click here to print.
Create Usage Plans
1 - 1.3
scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]
Description
Create usage plan
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| rate required | string | Usage Plan Rate | day |
| name required | string | Name | usage-plan-name |
| limit required | integer | Usage Plan Limit | 10 |
| description optional | string | Description | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Usage Plan ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_keys | API Keys | [] |
| created_at | Creation Date | |
| created_by_id | Created by | 27bb070b564349f8a31cc60734cc36a5 |
| created_by_name | Created by | username |
| description | Description | description |
| limit | Usage Plan Limit | 10 |
| modified_at | Modified at | |
| modified_by_id | Modified by | 27bb070b564349f8a31cc60734cc36a5 |
| modified_by_name | Modified by | username |
| name | Name | usage-plan-name |
| rate | Usage Plan Rate | day |
2 - 1.2
scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]
Description
Create usage plan
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.2 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| rate required | string | Usage Plan Rate | day |
| name required | string | Name | usage-plan-name |
| limit required | integer | Usage Plan Limit | 10 |
| description optional | string | Description | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Usage Plan ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_keys | API Keys | [] |
| created_at | Creation Date | |
| created_by_id | Created by | 27bb070b564349f8a31cc60734cc36a5 |
| created_by_name | Created by | username |
| description | Description | description |
| limit | Usage Plan Limit | 10 |
| modified_at | Modified at | |
| modified_by_id | Modified by | 27bb070b564349f8a31cc60734cc36a5 |
| modified_by_name | Modified by | username |
| name | Name | usage-plan-name |
| rate | Usage Plan Rate | day |
3 - 1.1
scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]
Description
Create usage plan
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| rate required | string | Usage Plan Rate | day |
| name required | string | Name | usage-plan-name |
| limit required | integer | Usage Plan Limit | 10 |
| description optional | string | Description | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Usage Plan ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_keys | API Keys | [] |
| created_at | Creation Date | |
| created_by_id | Created by | 27bb070b564349f8a31cc60734cc36a5 |
| created_by_name | Created by | username |
| description | Description | description |
| limit | Usage Plan Limit | 10 |
| modified_at | Modified at | |
| modified_by_id | Modified by | 27bb070b564349f8a31cc60734cc36a5 |
| modified_by_name | Modified by | username |
| name | Name | usage-plan-name |
| rate | Usage Plan Rate | day |