Add method request parameter

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Add a user-defined header or query parameter to the created method.

Request

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

Method	URI
POST	/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/parameters

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 whose parameter you want to add 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.

{
  "isRequired" : true,
  "parameterType" : "string",
  "isArray" : true,
  "parameterName" : "parameterName",
  "parameterDescription" : "parameterDescription",
  "parameterCode" : "REQUEST_HEADER"
}

Request body

The following describes the request body.

Field	Type	Required	Description
`isRequired`	Boolean	Optional	Whether the parameter is required `true` \| `false` `true`: required parameter `false`: optional parameter
`parameterType`	String	Optional	Parameter type `string` \| `boolean` \| `integer` \| `long` \| `float` \| `double`
`isArray`	Boolean	Optional	Whether it is an array type `true` \| `false` `true`: array type `false`: non-array type
`parameterName`	String	Required	Name of the parameter to save 1 - 100 characters
`parameterDescription`	String	Optional	Parameter description 0 - 300 characters
`parameterCode`	String	Required	Parameter code name `REQUEST_HEADER` \| `REQUEST_QUERY` \| `REQUEST_FORMDATA`

Request example

The following is a sample request.

curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/tf73xuex0v/methods/GET/parameters' \
--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 '{
  "isRequired" : false,
  "parameterType" : "integer",
  "isArray" : false,
  "parameterName" : "limit",
  "parameterDescription" : "Limit for pagination",
  "parameterCode" : "REQUEST_QUERY"
}'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
  "methodParameterDto" : {
    "resourceId" : "resourceId",
    "methodCode" : "methodCode",
    "tenantId" : "tenantId",
    "parameterCode" : "REQUEST_HEADER",
    "parameterType" : "string",
    "apiId" : "apiId",
    "parameterName" : "parameterName",
    "statusCode" : 6,
    "parameterDescription" : "parameterDescription",
    "isRequired" : true,
    "isArray" : true,
    "modifier" : "modifier",
    "parameterNo" : 0
  }
}

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.

{
    "methodParameterDto": {
        "resourceId": "tf73xuex0v",
        "methodCode": "0001",
        "tenantId": "********65ec41039ce6668c2058b8a9",
        "parameterCode": "REQUEST_QUERY",
        "parameterType": "integer",
        "apiId": "cvcohvd2xj",
        "parameterName": "limit",
        "statusCode": 0,
        "parameterDescription": "Limit for pagination",
        "isRequired": false,
        "isArray": false
    }
}

Was this article helpful?

What's Next

Delete method request parameter

Table of contents

Request
Response