MENU
      Associate usage plan

        Associate usage plan


        Article summary

        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:

        MethodURI
        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.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID that the stage belongs to
        api-idStringRequiredID of the API that the stage belongs to
        stage-idStringRequiredID of the stage to associate the usage plans with

        Request syntax

        The request syntax is as follows.

        {
            "usagePlanId" : "usagePlanId"
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        usagePlanIdStringRequiredID 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***"
        }'
        Curl

        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?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.