MENU
      Delete method request parameter

        Delete method request parameter


        Article summary

        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:

        MethodURI
        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.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID that the API belongs to
        api-idStringRequiredID of the API whose parameter you want to delete
        resource-idStringRequiredID of the target resource in the API
        method-nameStringRequiredTarget method type
        • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

        Request syntax

        The request syntax is as follows.

        {
          "parameterName" : "parameterName"
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        parameterNameStringRequiredName of the header, query string, or form data
        • It can only be handled in singular

        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"
        }'
        Curl

        Response

        The following describes the response format.

        Response status codes

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


        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.