View method request body
    • PDF

    View method request body

    • PDF

    Article summary

    Available in Classic and VPC

    View the request body of a customized method.

    Request

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

    MethodURI
    GET/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/request-body

    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 request body you want to view
    resource-idStringRequiredID of the target resource in the API
    method-nameStringRequiredTarget method type
    • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

    Request example

    The following is a sample request.

    curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/tf73xuex0v/methods/POST/request-body' \
    --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'
    

    Response

    The following describes the response format.

    Response syntax

    The response syntax is as follows.

    {
      "modelId" : "modelId",
      "modelName" : "modelName",
      "bodyName" : "bodyName",
      "bodyDescription" : "bodyDescription"
    }
    

    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.

    {
        "modelId": "qw33h0i33i",
        "modelName": "ApiKeyDto",
        "bodyName": "apiKey",
        "bodyDescription": "request body"
    }
    

    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.