API Keys

Available in Classic and VPC

An API key is a value used to grant permissions that allow users, such as app developers, to access and use APIs registered in API Gateway.
In API Keys, you can create and manage API keys and link them to stages.

API Keys interface and list

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

Component	Description
① Menu name	Current menu name. Number of API keys in operation
② Basic features	Create an API Key, view API Gateway details, refresh the page.
③ Edit	Edit an API Key in operation.
④ Delete	Delete an API Key in operation.
⑤ View linked stages	View the stages linked to the API key, check usage, and cancel subscriptions. For instructions on linking an API key to a stage, seeLink and manage API keys for stages.
⑥ Search bar	Enter the API Key name, then click to search for items.
⑦ Sort	Set the number of API keys to display on each list page.
⑧ API Keys list	View the list of API keys in operation. API Key ID: The ID of the created API key (automatically assigned). API Key name: The name set when creating the API key. Description: The description entered when creating the API key. Status: The current active or inactive status of the API key. When Creating an API Key, the key is automatically activated, and you can change its activation status (see Edit an API Key). API Keys: Click [View] to View, regenerate or copy an API key.

Create an API Key

To use APIs registered in API Gateway, you must first create an API key.

To create an API key:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the API Keys menu.
3. Click [Create API Key].
4. Enter the API key creation details, and then click [Save].
   • Name: Enter the name of the API key.
   • Description: Enter the description of the API key.
5. Verify that the created API key appears in the API Keys list.

View, regenerate, and copy an API key

To view, regenerate, and copy a created API key:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the API Keys menu.
3. In the API Keys list, click [View] for the target API key.
4. In the View API Keys popup, view, regenerate, or copy the API key as needed.
   • Primary Key/Secondary Key: Values that must be included in the request header when calling the API.
   • To regenerate the API key, click , review the details in the regeneration confirmation popup, and click [Yes].
   • To copy the API key to the clipboard, click .
5. Click [OK].

Edit an API Key

You can edit the API key name, description, and activation status.
To edit an API key:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the API Keys menu.
3. In the API Keys list, select the API key you want to modify, then click [Edit].
4. On the Edit API Key interface, update the settings, then click [Save].
   • ID: Display the automatically generated API key ID.
   • Name: Edit the API key name entered at creation.
   • Description: Add or edit the API key description entered at creation.
   • Activation: Select whether to activate the API key. Configure to inactive if you do not want to use the API key.
5. Verify that the API key has been updated in the API Keys list.

Delete an API Key

To delete an API key:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the API Keys menu.
3. In the API Keys list, select the API key you want to delete, then click [Delete].
4. Check the details in the Delete popup and click [Delete].

View and manage linked stages

You can view the stages linked to an API key in a list, check API usage, or unlink them (cancel subscriptions).

View linked stages

To view stages linked to an API key:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the API Keys menu.
3. In the API Keys list, select the API key for which you want to view linked stages, then click [View linked stages].
4. In the Stage connection popup, check the status of the API key.
   • Product name: The name of the Product that contains the linked stage.
   • Description: The description entered when creating the Product.
   • Status: The current status of the API key.
   • Request time: The date and time when the API key and stage connection was requested.
   • Edit time: The date and time when the API key status was edited.
   • To Check API usage, select the target Product name, then click [View usage].
   • To Unlink the stage (cancel subscriptions), select the target Product name, then click [Cancel subscriptions].

View API usage

To view API usage for stages linked to an API key:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the API Keys menu.
3. In the API Keys list, select the target API key, then click [View linked stages].
4. Select the Product name for which you want to view API usage, then click [View usage].
5. Review the information on the View usage interface.
   • Product name: The name of the Product that contains the stage linked to the API key.
   • API name: The name of the API linked to the API key.
   • Stage name: The name of the stage linked to the API key.
   • Daily call count/Daily request limit: The daily call count and the daily request limit set in the Usage Plan.
   • Monthly call count/Monthly request limit: The monthly call count and the monthly request limit set in the Usage Plan.

Unlink stage (cancel subscriptions)

To unlink a stage (cancel subscriptions) linked to API Keys:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the API Keys menu.
3. In the API Keys list, select the target API key, then click [View linked stages].
4. On the connected stages list interface, select the stage you want to disconnect, then click [Cancel subscriptions].
5. Check the content in the Import API popup and click [Yes].
6. Verify that the stage has been removed from the Linked stages list.
   • If the API key for the Product is set to Approved and you unlink the stage, the corresponding API key entry is also removed from the Product’s API Keys list.
   • If the API key for the Product is set to Rejected and you unlink the stage, the corresponding entry is not removed from the Product’s API Keys list and is displayed as Request rejected.