Associate usage plan
- Print
- PDF
Associate usage plan
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Associate a specific usage plan with a specified stage.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| POST | /products/{product-id}/apis/{api-id}/stages/{stage-id}/associate-usage-plan |
Request headers
For headers common to API Gateway, see API Gateway common headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
product-id | String | Required | Product ID that the stage belongs to
|
api-id | String | Required | ID of the API that the stage belongs to
|
stage-id | String | Required | ID of the stage to associate the usage plans with
|
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 associate
|
Request example
The following is a sample request.
curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***fh5o***/associate-usage-plan' \
--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" : "***xogj***"
}'
Response
The following describes the response format.
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.
Was this article helpful?