Edit method

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Change the settings of a customized method.

Request

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

Method	URI
PATCH	/products/{product-id}/apis/{api-id}/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.

Field	Type	Required	Description
`product-id`	String	Required	Product ID that the API belongs to 1 - 10 Check through View product list
`api-id`	String	Required	ID of the API to edit 1 - 10 characters Check through View API
`resource-id`	String	Required	ID of the target resource in the API 1 - 10 characters Check through View resource list
`method-name`	String	Required	Target method type `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD`

Request syntax

The request syntax is as follows.

{
  "methodDescription" : "methodDescription",
  "httpEndPoint" : {
    "method" : "ANY",
    "stream" : true,
    "url" : "url"
  },
  "mockEndPoint" : {
    "headers" : {
      "key" : "value"
    },
    "response" : "response",
    "httpStatus" : 0
  },
  "ncpEndPoint" : {
    "method" : "ANY",
    "stream" : true,
    "service" : "service",
    "actionId" : "actionId",
    "region" : "KR",
    "url" : "url",
    "actionName" : "actionName"
  },
  "requiredApiKey" : {
    "required" : true
  },
  "validation" : {
    "headers" : [ "headers" ],
    "queryStrings" : [ "queryStrings" ],
    "type" : "NONE"
  },
  "authentication" : {
    "authorizerId" : "authorizerId",
    "platform" : "NONE"
  }
}

Request body

The following describes the request body.

Field	Type	Required	Description
`methodDescription`	String	Optional	Method description 0 - 300 characters
`httpEndPoint`	String	Conditional	Endpoint type that returns the result of a call to an HTTP(S) endpoint Select one from `mockEndPoint`, `ncpEndPoint`, and `httpEndPoint`
`httpEndPoint.method`	String	Conditional	Method type to request from the backend server `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD` `Required when selecting the httpEndPoint` type
`httpEndPoint.stream`	Boolean	Conditional	Whether to use the stream feature `true` \| `false` `true`: The stream feature is used. Use it for requests that are file uploads in nature. Response time is limited to 5 minutes and request size to 100 MB `false`: The stream feature is not used. Response time is limited to 30 seconds and request size to 10 MB Required when selecting the `httpEndPoint` type
`httpEndPoint.url`	String	Conditional	URL path to request to the backend server Exclude domains The query string and headers defined in the resource path variable and request parameters can be used. Define using "{}" when used. 1 - 1500 characters Required when selecting the `httpEndPoint` type
`mockEndPoint`	String	Conditional	Endpoint type that returns the value set in the API Gateway Select one from `mockEndPoint`, `ncpEndPoint`, and `httpEndPoint`
`mockEndPoint.httpStatus`	Integer	Conditional	Response status code Required when selecting the `mockEndPoint` type Equivalent to the Response Status Code in HTTP
`mockEndPoint.headers`	Map<String, String>	Optional	Header to include in the response Header key, value form
`mockEndPoint.response`	String	Optional	Data to display in the response 0 - 1500 characters
`ncpEndPoint`	String	Conditional	Endpoint type that returns a value using a service of NAVER Cloud Platform Select one from `mockEndPoint`, `ncpEndPoint`, and `httpEndPoint`
`ncpEndPoint.service`	String	Conditional	Service on NAVER Cloud Platform to use for returning responses Cloud Functions service can be used Required when selecting the `ncpEndPoint` type
`ncpEndPoint.region`	String	Conditional	Supported Region code of the Cloud Functions serviceul> `KR` \| `JPN` \| `SGN` Required when selecting the `ncpEndPoint` type
`ncpEndPoint.actionId`	String	Conditional	Action ID of the Cloud Functions service Required when selecting the `ncpEndPoint` type
`ncpEndPoint.actionName`	String	Conditional	Action name of the Cloud Functions service Required when selecting the `ncpEndPoint` type
`ncpEndPoint.url`	String	Conditional	URL path of the Cloud Functions service Required when selecting the `ncpEndPoint` type
`ncpEndPoint.method`	String	Optional	Method type to request from the Cloud Functions service `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD`
`ncpEndPoint.stream`	Boolean	Conditional	Whether to use the stream feature `true` \| `false` `true`: The stream feature is used `false`: The stream feature is not used Required when selecting the `ncpEndPoint` type
`requiredApiKey`	String	Required	API key usage information
`requiredApiKey.required`	Boolean	Required	Whether to use API key `true` \| `false` `true`: API key is used `false`: API key is not used. Product subscription method and usage plan are not applied
`validation`	String	Required	Validity check information
`validation.type`	String	Required	Validity check range `NONE` \| `QUERYSTRING_HEADERS` `NONE`: No validaty check is run `QUERYSTRING_HEADERS`: Run validaty check for the query string and headers
`validation.headers`	List<String>	Conditional	List of required headers subject to validity check Enter when selecting `QUERYSTRING_HEADERS`
`validation.queryStrings`	List<String>	Conditional	List of required query strings subject to validity check Enter when selecting `QUERYSTRING_HEADERS`
`authentication`	String	Required	Authentication information
`authentication.platform`	String	Required	Set authentication method `NONE` \| `IAM` \| `AUTHORIZER` `NONE`: no authentication `IAM`: Use IAM authentication provided by NAVER Cloud Platform `AUTHORIZER`: Use a pre-created authorizer
`authentication.authorizerId`	String	Conditional	ID of the authorizer to use when using the authorizer as the authentication method

Request example

The following is a sample request.

curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/p1hiuvmwv3/methods/OPTIONS' \
--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 '{
  "mockEndPoint": {
    "httpStatus": 400,
    "response": "user error"
  },
    "authentication": {
    "platform": "NONE"
  },
  "requiredApiKey": {
    "required": true
  },
  "validation": {
    "type": "NONE"
  }
}'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
  "method" : {
    "methodDescription" : "methodDescription",
    "resourceId" : "resourceId",
    "useBodyWhenFormData" : true,
    "modifier" : "modifier",
    "resourcePath" : "resourcePath",
    "methodName" : "ANY",
    "ncpEndPoint" : {
      "method" : "ANY",
      "stream" : true,
      "service" : "service",
      "actionId" : "actionId",
      "region" : "KR",
      "url" : "url",
      "actionName" : "actionName"
    },
    "requiredApiKey" : {
      "required" : true
    },
    "mockEndPoint" : {
      "headers" : {
        "key" : "headers"
      },
      "response" : "response",
      "httpStatus" : 0
    },
    "produces" : "produces",
    "tenantId" : "tenantId",
    "consumers" : "consumers",
    "apiId" : "apiId",
    "validation" : {
      "headers" : [ "headers" ],
      "queryStrings" : [ "queryStrings" ],
      "type" : "NONE"
    },
    "authentication" : {
      "authorizerId" : "authorizerId",
      "platform" : "NONE"
    },
    "httpEndPoint" : {
      "method" : "ANY",
      "stream" : true,
      "url" : "url"
    }
  }
}

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.

{
  "method": {
    "apiId": "cvcohvd2xj",
    "resourceId": "p1hiuvmwv3",
    "methodName": "GET",
    "useBodyWhenFormData": false,
    "validation": {
      "type": "NONE"
    },
    "authentication": {
      "platform": "NONE"
    },
    "requiredApiKey": {
      "required": true
    },
    "mockEndPoint": {
      "httpStatus": 400,
      "response": "user error"
    },
    "tenantId": "********65ec41039ce6668c2058b8a9",
    "modifier": "********-7fcd-11ec-a6ba-246e9659184c"
  }
}

Was this article helpful?

What's Next

Save method request body

Table of contents

Request
Response