MENU
      View published API document

        View published API document


        Article summary

        Available in Classic and VPC

        View a specific API document among API documents published in a specified product.

        Request

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

        MethodURI
        GET/published-products/{product-id}/apis/{api-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 that the API belongs to
        api-idStringRequiredID of the API whose document you want to view

        Request example

        The following is a sample request.

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

        {
            "apiId" : "apiId",
            "documentMd" : "documentMd",
            "tenantId" : "tenantId",
            "modifier" : "modifier"
        }
        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.

        {
            "apiId": "***51hs***",
            "documentMd": "",
            "tenantId": "***e230cebc1402ba89b148896951***",
            "modifier": "***d3020-5bb7-11ec-bfb8-246e96591***"
        }
        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.