Disassociate usage plan

Prev Next

Available in Classic and VPC

Disassociate a specific usage plan associated with a specified stage.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
POST /api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/disassociate-usage-plan

Request headers

For information about the headers common to all API Gateway APIs, see API Gateway request headers.

Request path parameters

You can use the following path parameters with your request:

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 disassociate the usage plan from

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 disassociate

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***/disassociate-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 information about the HTTP status codes common to all API Gateway APIs, see API Gateway response status codes.