MENU
      View product overview

        View product overview


        Article summary

        Available in Classic and VPC

        View the overview of a specified product.

        Request

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

        MethodURI
        GET/products/{product-id}/overview

        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 whose overview you want to view

        Request example

        The following is a sample request.

        curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/overview' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
            "apis" : [ {
                "apiName" : "apiName",
                "domainCode" : "domainCode",
                "methodsCount" : 2,
                "stages" : [ {
                    "deployedStageDeploymentNo" : 0,
                    "stageName" : "stageName",
                    "host" : "host",
                    "stageId" : "stageId"
                } ],
                "apiId" : "apiId"
            } ],
            "apiKeyCountInfo" : {
                "request" : 5,
                "total" : 5,
                "rejected" : 1,
                "accepted" : 0,
                "denied" : 6
            }
        }
        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.

        {
            "apis": [
                {
                    "stages": [
                        {
                            "stageId": "***5ei7***",
                            "stageName": "stage",
                            "deployedStageDeploymentNo": 250***,
                            "host": "https://***ksk9***.apigw.ntruss.com"
                        }
                    ],
                    "apiId": "***51hs***",
                    "apiName": "api000",
                    "methodsCount": 6
                }
            ],
            "apiKeyCountInfo": {
                "accepted": 0,
                "rejected": 0,
                "request": 0,
                "denied": 0,
                "total": 0
            }
        }
        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.