Add method response
    • PDF

    Add method response

    • PDF

    Article summary

    Available in Classic and VPC

    Define and add a response status code for a created method.

    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}/responses

    Request headers

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

    Request path parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    product-idStringRequiredProduct ID that the API belongs to
    api-idStringRequiredID of the API whose response you want to add
    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.

    {
      "responseDescription" : "responseDescription",
      "statusCode" : 0
    }
    

    Request body

    The following describes the request body.

    FieldTypeRequiredDescription
    responseDescriptionStringOptionalResponse description
    • 0 - 300 characters
    statusCodeIntegerRequiredResponse status code
    • 100 - 599

    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/responses' \
    --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 '{
      "responseDescription" : "Bad Request",
      "statusCode" : 400
    }'
    

    Response

    The following describes the response format.

    Response syntax

    The response syntax is as follows.

    {
      "methodResponseDto" : {
        "tenantId" : "tenantId",
        "apiId" : "apiId",
        "resourceId" : "resourceId",
        "methodCode" : "methodCode",
        "statusCode" : 0,
        "responseDescription" : "responseDescription",
        "modifier" : "modifier"
      }
    }
    

    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.

    {
        "methodResponseDto": {
            "tenantId": "********65ec41039ce6668c2058b8a9",
            "apiId": "cvcohvd2xj",
            "resourceId": "tf73xuex0v",
            "methodCode": "0001",
            "statusCode": 400,
            "responseDescription": "Bad Request",
            "modifier": "********-7fcd-11ec-a6ba-246e9659184c"
        }
    }
    

    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.