Available in Classic and VPC
Change the usage plan for the specified API key by selecting from the usage plans associated with the stage.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| PUT | /products/{product-id}/api-keys/{api-key-id}/stages/{stage-id} |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
product-id |
String | Required | Product ID that the API key belongs to
|
api-key-id |
String | Required | API key ID whose usage plan you want to change
|
stage-id |
String | Required | Stage ID
|
Request syntax
The request syntax is as follows.
{
"usagePlanId" : "usagePlanId"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
usagePlanId |
String | Required | ID of usage plan to change
|
Request example
The following is a sample request.
curl --location --request PUT 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/api-keys/***fmy2***/stages/***5ei7***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"usagePlanId" : "***9rpm***"
}'
Response
The following describes the response format.
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.