Available in Classic and VPC
Delete a desired item from added request parameters (headers, query strings).
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/delete |
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
|
api-id |
String | Required | ID of the API whose parameter you want to delete
|
resource-id |
String | Required | ID of the target resource in the API
|
method-name |
String | Required | Target method type
|
Request syntax
The request syntax is as follows.
{
"parameterName" : "parameterName"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
parameterName |
String | Required | Name of the header, query string, or form data
|
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/delete' \
--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 '{
"parameterName" : "distance"
}'
Response
The following describes the response format.
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.