MENU
      View product document

        View product document


        Article summary

        Available in Classic and VPC

        View documents for a specified product among the products in all accounts.

        Request

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

        MethodURI
        GET/published-products/{product-Id}/documents

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        offsetLongOptionalStarting point of the response data
        • 0 - 9,223,372,036,854,775,807
        • It is used with limit to implement pagination
        limitLongOptionalMaximum number of response data
        • 1 - 9,223,372,036,854,775,807
        • It is used with offset to implement pagination
        apiNameStringOptionalAPI name
        • 0 - 20 characters

        Request example

        The following is a sample request.

        curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/published-products/***ksk9***/documents?apiName=api000' \
        --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.

        {
            "apiPage" : {
                "total" : 6,
                "content" : [ {
                    "apiName" : "apiName",
                    "domainCode" : "domainCode",
                    "stages" : [ {
                        "deployedStageDeploymentNo" : 0,
                        "stageName" : "stageName",
                        "host" : "host",
                        "stageId" : "stageId"
                    } ],
                    "apiDescription" : "apiDescription",
                    "apiId" : "apiId"
                } ]
            }
        }
        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.

        {
            "apiPage": {
                "content": [
                    {
                        "stages": [
                            {
                                "stageId": "***5ei7***",
                                "stageName": "stage",
                                "deployedStageDeploymentNo": 251***,
                                "host": "https://***ksk9***.apigw.ntruss.com"
                            }
                        ],
                        "apiId": "***51hs***",
                        "apiName": "api000",
                        "apiDescription": "",
                        "domainCode": "PUB"
                    }
                ],
                "total": 1
            }
        }
        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.