MENU
      Create usage plan

        Create usage plan


        Article summary

        Available in Classic and VPC

        Create a usage plan according to the user-defined conditions.

        Request

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

        MethodURI
        POST/usage-plans

        Request headers

        For headers common to API Gateway, see API Gateway common request headers.

        Request syntax

        The request syntax is as follows.

        {
            "monthQuotaRequest" : 1,
            "dayQuotaRequest" : 6,
            "usagePlanDescription" : "usagePlanDescription",
            "rateRps" : 0,
            "quotaCondition" : "quotaCondition",
            "usagePlanName" : "usagePlanName"
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        monthQuotaRequestLongConditionalMonthly request processing limit (cases/month)
        • 0 - 9,223,372,036,854,775,807
        • Required when entering dayQuotaRequest
        dayQuotaRequestLongConditionalDaily request processing limit (cases/day)
        • 1 - 9,223,372,036,854,775,807
        • Required when entering monthQuotaRequest
        usagePlanDescriptionStringOptionalDescription for the usage plan to create
        • 0 - 50 characters
        rateRpsLongOptionalRequest throughput (cases/second)
        • 1 - 2,147,483,647
        quotaConditionStringOptionalUsage control conditions
        • 2xx | 3xx | 4xx | 5xx | others
        usagePlanNameStringRequiredName of usage plan to create
        • 0 - 45 characters

        Request example

        The following is a sample request.

        curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans' \
        --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 '{
            "monthQuotaRequest": 10,
            "dayQuotaRequest": 5,
            "rateRps": 2,
            "quotaCondition": "2xx",
            "usagePlanDescription": "usage plan",
            "usagePlanName": "usageplan000"
        }'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
            "usagePlan" : {
                "domainCode" : "domainCode",
                "usagePlanId" : "usagePlanId",
                "modifier" : "modifier",
                "associatedStagesCount" : 0,
                "dayQuotaRequest" : 6,
                "permission" : "permission",
                "rateRps" : 5,
                "usagePlanName" : "usagePlanName",
                "monthQuotaRequest" : 1,
                "tenantId" : "tenantId",
                "disabled" : true,
                "usagePlanDescription" : "usagePlanDescription",
                "quotaCondition" : "quotaCondition",
                "actionName" : "actionName"
            }
        }
        JSON

        Response status codes

        For response status codes common to API Gateway, see API Gateway response status codes.

        Response example

        The following is a sample response.

        {
            "usagePlan": {
                "tenantId": "***e230cebc1402ba89b148896951***",
                "usagePlanId": "***wthl***",
                "rateRps": 2,
                "usagePlanName": "usageplan000",
                "usagePlanDescription": "usage plan",
                "dayQuotaRequest": 5,
                "quotaCondition" : "2xx",
                "monthQuotaRequest": 10,
                "domainCode": "PUB",
                "associatedStagesCount": 0
            }
        }
        JSON

        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.