MENU
      Preview model

        Preview model


        Article summary

        Available in Classic and VPC

        Preview the operation status of the body model you created.

        Request

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

        MethodURI
        POST/products/{product-id}/apis/{api-id}/models/preview

        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 model you want to preview

        Request syntax

        The request syntax is as follows.

        {
          "modelId" : "modelId",
          "modelSchema" : "modelSchema"
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        modelIdStringOptionalTarget model ID
      • Check through View model
      • modelSchemaStringRequiredSchema of the defined model
      • Check through View model
      • Request example

        The following is a sample request.

        curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/models/preview' \
        --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 '{
          "modelId" : "qw33h0i33i",
          "modelSchema" : "{\n  \"type\": \"object\",\n  \"properties\": {\n    \"apiKeyDescription\": { \"type\": \"string\" },\n    \"apiKeyId\": { \"type\": \"string\" },\n    \"apiKeyName\": { \"type\": \"string\" }\n  },\n  \"description\": \"model description\"\n}\n"
        }'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
          "modelSchema" : {}
        }
        JSON

        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.

        {
            "modelSchema": {
                "type": "object",
                "properties": {
                    "apiKeyDescription": {
                        "type": "string"
                    },
                    "apiKeyId": {
                        "type": "string"
                    },
                    "apiKeyName": {
                        "type": "string"
                    }
                },
                "description": "model description"
            }
        }
        JSON

        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.