---
title: "Published APIs"
slug: "apigw-publishedapis"
tags: ["API Gateway"]
updated: 2026-09-17T09:18:10Z
published: 2026-09-17T09:18:10Z
canonical: "guide.ncloud-docs.com/apigw-publishedapis"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://guide.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Published APIs

Available in Classic and VPC

You can share a Product’s API documentation or subscribe to API documentation shared by other users.

              Note

              

For instructions on publishing, viewing, and managing API documentation for a created Product, see [Check Catalog](/docs/en/apigw-myproducts#Catalog%ED%99%95%EC%9D%B8) in the **My Products** menu.

## Published APIs interface and list

The following provides a basic overview of the Published APIs menu for using API Gateway:

![apigw-publishedapis-list_ko](https://cdn.document360.io/6998976f-9d95-4df8-b847-d375892b92c2/Images/Documentation/apigw-publishedapis-list_en.png?sv=2026-02-06&spr=https&st=2026-11-14T04%3A14%3A19Z&se=2026-11-14T05%3A14%3A19Z&sr=c&sp=r&sig=sMC9tXqVdcxT7J0km%2FqzmEPC6ucozIsO2rF9%2Bu1i9fk%3D)

| Component | Description |
| --- | --- |
| ① Menu name | Current menu name. Number of subscribable Products. |
| ② Basic features | View API Gateway details and refresh the page. |
| ③ **Catalog** | View and subscribe to API documentation shared by you and other users. |
| ④ Search bar | Enter the Product name and click ![i-apigateway-find](https://cdn.document360.io/6998976f-9d95-4df8-b847-d375892b92c2/Images/Documentation/i-apigateway-find.png?sv=2026-02-06&spr=https&st=2026-11-14T04%3A14%3A19Z&se=2026-11-14T05%3A14%3A19Z&sr=c&sp=r&sig=sMC9tXqVdcxT7J0km%2FqzmEPC6ucozIsO2rF9%2Bu1i9fk%3D) to search for items. |
| ⑤ Filter | Filter items by API provider location (default: **NCP**), and subscription status. - Change the filter to view APIs other than those provided by the NAVER Cloud Platform. - Select **My** to search for APIs published by the user. |
| ⑥ Sort | Set the number of APIs displayed per list page. |
| ⑦ List | List of APIs shared by you and other users. - **Product name**: The name of the published Product. - **Description**: The description of the published Product. - **Subscription type**: The subscription type of the published Product (**Public**, **Protected**). - **Subscription**: Indicate whether you are subscribed to the published Product. |

## View Catalog

You can view the Overview of APIs created in a Product and view stage documents through Swagger UI. For APIs published by the user, you can edit the Overview content.

To view the Overview and Document of a published API:

1. In the NAVER Cloud Platform console, navigate to **Menu** > **All Services** > **Application Services** > **API Gateway**.
2. Click the **Published APIs** menu.
3. In the published Product list, select the Product you want to review, then click **[Catalog]**.
  - To view APIs other than those provided by the NAVER Cloud Platform, change the **Product** filter.
4. In the Product Catalog list, click the name of the API you want to review.
5. On the details interface, review the API Overview and the Stage Document.
  - For APIs created by the user, **[Edit]** appears, allowing you to modify the Overview. To edit the Overview, click **[Edit]**, update the content, then click **[Save]**. For details on writing an Overview, see [Write an Overview in API documentation](/docs/en/apigw-myproducts#API%EC%84%A4%EB%AA%85%EC%84%9C%EC%9D%98Overview%EC%9E%91%EC%84%B1).
  - To view the Stage Document through Swagger UI, click the stage name or ![i-apigateway-view](https://cdn.document360.io/6998976f-9d95-4df8-b847-d375892b92c2/Images/Documentation/i-apigateway-view.png?sv=2026-02-06&spr=https&st=2026-11-14T04%3A14%3A19Z&se=2026-11-14T05%3A14%3A19Z&sr=c&sp=r&sig=sMC9tXqVdcxT7J0km%2FqzmEPC6ucozIsO2rF9%2Bu1i9fk%3D).

## Catalog subscription request

Published Products support two subscription types: **Public** and **Protected**.

- **Public**: Anyone can call the Product APIs without an approval process, and **[Subscribe]** is not displayed on the Catalog list interface.
- **Protected**: Approval from the publisher is required to use the Product APIs, and **[Subscribe]** is displayed on the Catalog list interface.

If the subscription type of a published Product is **protected**, you must [Create an API Key](/docs/en/apigw-apigw-2-5#APIKey%EC%83%9D%EC%84%B1) and complete the API key approval process to subscribe.

To request a Catalog subscription:

1. In the NAVER Cloud Platform console, navigate to **Menu** > **All Services** > **Application Services** > **API Gateway**.
2. Click the **Published APIs** menu.
3. In the Published APIs menu, select a Product with a **protected** subscription type, then click **[Catalog]**.
4. In the Product Catalog list, click **[Subscribe]**.
5. Select the API key to be authorized for the API you want to subscribe to, then click **[Request subscription]**.
6. In the Subscribe popup, click **[Request subscription]**.
  - After the subscription request is completed, the value in the **subscription** column for the Product changes from **unsubscribed** to **Requested**.
  - You can also check the subscription status in the [Connected stage list](/docs/en/apigw-apigw-2-5#%EC%97%B0%EA%B2%B0%EB%90%9CStage%ED%99%95%EC%9D%B8) in the **API Keys** menu.
  - For details on API subscription status, see [Change API Key status](/docs/en/apigw-myproducts#APIKey%EC%9D%98%EC%83%81%ED%83%9C%EB%B3%80%EA%B2%BD).
  - To cancel an API subscription, see [Disconnect stage (unsubscribe)](/docs/en/apigw-apigw-2-5#Stage%EC%97%B0%EA%B2%B0%ED%95%B4%EC%A0%9C%EA%B5%AC%EB%8F%85%EC%B7%A8%EC%86%8C) in the **API Keys** menu.