MENU
      Overwrite stage method settings

        Overwrite stage method settings


        Article summary

        Available in Classic and VPC

        Overwrite the method settings for a specified stage with the newly specified method settings.

        Request

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

        MethodURI
        PATCH/products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments/{deployment-no}/resources/{resource-id}/methods/{method-name}

        Request headers

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

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID
        api-idStringRequiredAPI ID
        • 0 - 10 characters
        • Check through the View API action
        stage-idStringRequiredStage ID
        deployment-noLongRequiredDeployment number
        resource-idStringRequiredResource ID of the stage
        method-nameStringRequiredMethod whose settings you want to overwrite
        • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

        Request syntax

        The request syntax is as follows.

        {
            "cacheTtlSec" : 0,
            "throttleRps" : 6,
            "isInherit" : true,
            "endpointDomain" : "endpointDomain"
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        cacheTtlSecIntegerOptionalAPI cache TTL
        • 1 - 3600 seconds
        throttleRpsIntegerOptionalPer-method per-second request limit
        • 0 - 2,147,483,647
        isInheritBooleanRequiredCompliance with stage default settings
        • true | false
          • true: compliant
          • false: non-compliant
        endpointDomainStringOptionalEndpoint domain

        Request example

        The following is a sample request.

        curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/***3kew***/apis/***hhdy***/stages/***sd32***/deployments/250***/resources/***uku7***/methods/GET' \
        --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 '{
            "cacheTtlSec" : 0,
            "throttleRps" : 6,
            "isInherit" : true,
            "endpointDomain" : "https://test.****"
        }'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
            "stageMethod" : {
                "resourceId" : "resourceId",
                "endpointCode" : "endpointCode",
                "resourcePath" : "resourcePath",
                "methodName" : "ANY",
                "isInherit" : true,
                "methodCode" : "methodCode",
                "endpointDomain" : "endpointDomain",
                "cacheTtlSec" : 0,
                "restUrl" : "restUrl",
                "throttleRps" : 1,
                "endpointActionId" : "endpointActionId",
                "invokeUrl" : "invokeUrl",
                "stageDeploymentNo" : 6,
                "endpointConfigJson" : "endpointConfigJson"
            }
        }
        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.

        {
          "stageMethod": {
            "stageDeploymentNo": 256366,
            "methodName": "PUT",
            "methodCode": "0003",
            "resourceId": "1lynl7fvad",
            "invokeUrl": "https://rl5qpeuk8w.apigw.ntruss.com/new_api/test/",
            "restUrl": "test - PUT /",
            "endpointCode": "0007",
            "endpointConfigJson": "{\"httpStatus\":200,\"response\":\"\",\"headers\":{}}",
            "isInherit": true
          }
        }
        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.