MENU
      View API_infos

        View API_infos


        Article summary

        Available in Classic and VPC

        View API information.
        This API performs queries without a sub account resource list check (SubAccountResourceListCheck).

        Request

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

        MethodURI
        GET/products/{product-id}/apis/infos

        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 associated with the API

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        offsetLongOptionalStarting point in the list of data to view
        • 0 - 9,223,372,036,854,775,807
        limitLongOptionalNumber of data to view at once
        • 1 - 9,223,372,036,854,775,807
        withStageBooleanOptionalWhether to view stage information
        • true | false
          • true: View stage information
          • false: Do not view stage information
        apiNameStringOptionalFilter by API name
        • 1 - 20
        hasStageBooleanOptionalFilter by stage presence or absence
        • true | false
          • true: stage present
          • false: stage not present
        hasStageNotAssociatedWithUsagePlanIdStringOptionalView excluding stages associated with a specific usage plan
        • Entering a specific usage plan ID returns APIs that are not related to that usage plan ID

        Request example

        The following is a sample request.

        curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/infos' \
        --header 'Content-Type: application/json' \
        --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 syntax is as follows.

        {
            "apis": [
                {
                    "stages": [
                        {
                            "apiId": "apiId",
                            "stageId": "stageId",
                            "stageName": "stageName",
                            "isPublished": true
                        }
                    ],
                    "productId": "productId",
                    "apiId": "apiId",
                    "apiName": "apiName",
                    "apiDescription": "apiDescription",
                    "tenantId": "tenantId",
                    "modifier": "modifier",
                    "modTime": "2024-05-02T08:10:26Z",
                    "isDeleted": false,
                    "domainCode": "domainCode"
                }
            ],
            "total": 0
        }
        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": [
                        {
                            "apiId": "*****luwtk",
                            "stageId": "*****7mhdv",
                            "stageName": "v1",
                            "isPublished": true
                        }
                    ],
                    "productId": "*****xn0bk",
                    "apiId": "*****luwtk",
                    "apiName": "api",
                    "apiDescription": "",
                    "tenantId": "*****02f55ae4436913a6e2c65bab47c",
                    "modifier": "d12c9fd0-****-****-****-246e96591a38",
                    "modTime": "2024-05-02T08:10:26Z",
                    "isDeleted": false,
                    "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.