How-to guides

Users can create the service by entering the required information for the API Gateway service and selecting detailed options via the Samsung Cloud Platform Console.

Create API

An API is a collection of resources and methods integrated with backend HTTP endpoints, Cloud Functions, or other SCP services. The API provides a logical interface for the actual service and can be deployed across multiple stages for use in various environments (development, production, etc.).

You can create an API in the Samsung Cloud Platform Console and use it.

To create an API, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. 1. Go to the Service Home page of API Gateway.
2. On the Service Home page, click the Create API button. 2. Go to the API creation page.
3. On the API creation page, enter the information required to create the service and select detailed options.
   • Select the required information in the Service Information Input area.

     Category	Required	Detailed description
     API name	required	Enter API name must start with a lowercase English letter and must not end with a special character (-) , use lowercase letters, numbers and special characters (-) to input 3 ~ 50 characters
     How to create an API	required	Select API creation method Create new, Clone existing API – choose
     API to duplicate	Required	When selecting Existing API Replication as the API creation method, choose from among APIs that have already been created.
     Explanation	Selection	Enter API info or description within 50 chars
     API endpoint type	required	Path to access the API Region: Process requests within the region where the API is deployed Private: Expose the API so that it can only be requested privately from other VPCs When Private is selected, JWT activation is applied

     Table. API Service Information Input Items

• Enter or select the required information in the Additional Information Input area.

  Category	Required	Detailed description
  tag	Selection	Add Tag Add Tag Click the button to create and add a tag, or add an existing tag You can add up to 50 tags The newly added tags are applied after the service creation is completed

  Table. API additional information input fields

4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • Once creation is complete, check the created resources on the API List page.

Check API details

You can view and edit the complete list of resources and detailed information of the API service. API Details page consists of Details, Tags, Activity Log tabs.

To view detailed information about the API service, follow these steps.

1. All Services > Application Service > API Gateway menu, click it. 1. Go to the Service Home page of API Gateway.
2. On the Service Home page, click the API menu. 2. Go to the API list page.
3. On the API List page, click the resource to view detailed information. 3. API Details page is accessed.
   • API Details page displays status information and additional feature information, and consists of the Details, Tags, Activity History tabs.

     Category	Detailed description
     Status display	User-created API status Creating: API creation in progress Active: API operating normally Deleting: API deletion in progress Error: API internal error makes it unavailable
     Service cancellation	Service cancellation button

     Table. API status information and additional features

Detailed Information

API Details page allows you to view detailed information of the selected resource and edit the information if needed.

Connection Management

Connection Management page allows you to manage connection requests for the API Gateway PrivateLink Service.

Tag

On the API Details page, you can view the tag information of the selected resource, and add, modify, or delete it.

Job History

You can view the operation history of the selected resource on the API Details page.

Integrating PrivateLink Service

By integrating the API Gateway service with the PrivateLink service, you can connect “API Gateway and VPC” or “API Gateway and other SCP services” without using the external internet. The data uses only the internal network, providing high security, and does not require a public IP, NAT, VPN, internet gateway, etc.

Creating a PrivateLink service for API Gateway

When creating an API, select the endpoint type as Private. You can expose the API so that it can be accessed privately from other VPCs or services.

Create PrivateLink Endpoint

You can create an Entry Point in the API Gateway service to access other PrivateLinks.

To create a PrivateLink Endpoint, follow these steps.

1. All Services > Application Service > API Gateway click the menu. 1. Navigate to the Service Home page of API Gateway.

2. On the Service Home page, click the PrivateLink Endpoint menu. 2. Go to the PrivateLink Endpoint List page.

3. On the PrivateLink Endpoint List page, click the Create PrivateLink Endpoint button. 3. Go to the Create PrivateLink Endpoint page.

   • Enter or select the required information.

     Category	Required	Detailed description
     PrivateLink Endpoint name	required	Enter PrivateLink Endpoint name Enter using letters and numbers, 3 to 20 characters
     Explanation	Selection	Enter additional information or description within 50 characters.
     PrivateLink Service ID	required	Enter the ID of the PrivateLink Service to connect Confirm the Service ID with the PrivateLink Service provider in advance, and after creating the Endpoint, provide the Endpoint ID to the provider Enter using letters and numbers, 3 to 60 characters

     Table. PrivateLink Endpoint creation information input fields

4. After entering or selecting the information, click the Confirm button.

5. After checking the message in the notification popup, click the Confirm button.

   • Once creation is complete, check the created resource in the PrivateLink Endpoint list.
   • To delete a PrivateLink Endpoint list, select the resource to remove from the list and click the Delete button.

View detailed information of PrivateLink Endpoint

You can view and edit the full list of resources and detailed information for a PrivateLink Endpoint. PrivateLink Endpoint Details page is composed of Detail Information and Operation History tabs.

To view detailed information about the API service, follow these steps.

1. All Services > Application Service > API Gateway Click the menu. 1. Go to the Service Home page of API Gateway.
2. On the Service Home page, click the PrivateLink Endpoint menu. 2. Go to the PrivateLink Endpoint List page.
3. On the PrivateLink Endpoint List page, click the resource to view detailed information. 3. Go to the PrivateLink Endpoint Details page.
   • PrivateLink Endpoint Details page displays status information and additional feature details, and consists of Details and Operation History tabs.

     Category	Detailed description
     Status display	PrivateLink Endpoint status Requesting: Connection request pending approval, Cancel request button displayed Active: Creation complete, operating Creating: Creating Deleting: Deleting Disconnected: Connection blocked Rejected: Connection rejected, Resubmit request button displayed Error: Error occurred Canceled: Connection request canceled, Resubmit request button displayed
     Cancel request	Cancel connection request
     Re-request approval	Re-request connection after the connection request was canceled

     Table. PrivateLink Endpoint status information and additional features

Detailed Information

On the PrivateLink Endpoint Details page, you can view detailed information of the selected resource.

Job History

PrivateLink Endpoint Details page allows you to view the operation history of the selected resource.

Create Resource

A resource is a logical unit that represents a specific endpoint (URI path) within an API. Each resource can be organized in a tree structure and can have multiple HTTP methods.

To create a resource, follow these steps.

1. All Services > Application Service > API Gateway Click the menu. 1. Go to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Resources menu. 2. Go to the Resources page.

3. On the Resource page, click the Create Resource button. 3. Create Resource Navigate to the popup window.

   • Enter or select the required information.

     Category	Required	Detailed description
     Resource name	required	Enter resource name must start with a lowercase English letter and be 3 to 50 characters using lowercase letters, numbers, and special characters (-{}) If curly braces are used, {character} is the only allowed format and cannot be left empty
     Resource path	required	Select the path chosen in the resource menu tree

     Table. Resource creation input fields

4. When the information entry and selection are complete, click the Confirm button.

5. After checking the message in the notification popup, click the Confirm button.

   • After creation is complete, check the created resource in the resource list.
   • To delete a resource, select the resource to delete from the list and click the Delete button.

Create Method

Methods define the HTTP actions (e.g., GET, POST, PUT, DELETE, etc.) that can be performed on each resource. Each method integrates with a specific backend to process real data or execute a function.

To create a method, follow these steps.

1. All Services > Application Service > API Gateway Click the menu. 1. Go to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Resources menu. 2. Navigate to the Resource page.

3. Click the Create Method button on the Resources page. 3. Create Method Navigate to the popup window.

   • Enter or select the required information.

     Category	Required status	Detailed description
     Method type	required	Select method type The generated value is not displayed in the list. Selecting ANY creates methods of all types
     Integration type	required	Select endpoint type Select from HTTP, Cloud Function, PrivateLink
     Endpoint URL	Required	Enter the endpoint URL when HTTP type is selected The endpoint is a unique URL used by the client to access the API. A separate endpoint is created for each stage. Various types such as Regional, Edge-Optimized, Private, etc. It must be a valid URL starting with http:// or https://, and must be entered within 500 characters using English letters and special characters ($-_.+!*’:(){}/)
     Endpoint	required	When the Cloud Function type is selected, endpoint selection the region is provided as the current region and cannot be changed
     URL query string parameter	Selection	After checking use, enter name using English letters, numbers, and special characters (_) to input
     HTTP request header	Selection	After checking Use, enter Name English letters, numbers, special characters(-)using
     API Key usage	Select	To limit usage through a usage policy, check Use

     Table. Method creation information input fields

4. After entering the information and making selections, click the Save button.

5. After checking the message in the notification popup, click the Confirm button.

   • After creation is complete, verify the created resource in the method list.
   • To delete a method, select the resource to delete from the list, then click the Delete button.

Deploy API

To apply a developing API to the actual service environment, API deployment is required.

To deploy the generated API, follow the steps below.

1. All Services > Application Service > API Gateway Click the menu. 1. Go to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Resources menu. 2. Go to the Resource page.

3. Resources page, click the API Deployment button. 3. API deployment Navigate to the popup window.

   • Enter or select the required information.

     Category	Required status	Detailed description
     Stage	required	Select the stage to deploy the API New Stage: Create a new stage and deploy None Stage: Deploy without selecting a stage
     Stage name	Required	When New Stage is selected, enter a new stage name It must start with a lowercase English letter and must not end with a special character (-), using lowercase letters, numbers, and special characters (-) to enter 3 to 30 characters
     deployment description	Select	Enter up to 50 chars of API deployment info

     Table. API deployment information input items

4. When the information entry and selection are complete, click the Deploy button.

5. After checking the message in the notification popup, click the Confirm button.

Create Stage

A stage is a named reference to a specific point in time (snapshot) of an API deployment, distinguishing environments in the API lifecycle such as development (dev), testing (test), and production (prod). Each stage has a unique URL, and you can configure separate settings for each environment, such as caching, logging, throttling, and stage variables. Through stages, we support various operational scenarios such as Canary releases, environment-specific configurations, and traffic segmentation.

To create a stage for deploying the API, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. 1. Go to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Stage menu. 2. Navigate to the Stage page.

3. On the Stage page, click the Create Stage button. 3. Stage Creation Navigate to the popup window.

   • Enter or select the required information.

     Category	Required	Detailed description
     Stage name	required	If New Stage is selected, enter the new stage name Start with a lowercase English letter and ensure it does not end with a special character (-), using lowercase letters, numbers, and special characters (-) to enter 3 to 50 characters
     Stage description	Selection	Enter additional information or description about the stage within 100 characters.
     API deployment version	Required	Select the API version to deploy Start with a lowercase English letter and ensure it does not end with a special character (-), using lowercase letters, numbers, and special characters (-) to input 3 ~ 50 characters

     Table. Stage creation information input items

4. When the information entry and selection are complete, click the Confirm button.

5. After checking the message in the notification popup, click the Confirm button.

   • Once creation is complete, check the created resources in the stage list.

View stage details

You can view and edit the stage list and detailed information. The detail page consists of Stage Details information and API Deployment Version Management, CORS, Usage Policy tabs.

To view the detailed information of the stage, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. 1. Navigate to the Service Home page of API Gateway.
2. Click the API Gateway > Stage menu on the Service Home page. 2. Navigate to the Stage page.
3. Click the resource to view detailed information in the stage list.
   • Stage Details displays status information and additional feature information, and consists of API Deployment Version Management, CORS, Usage Policy tabs.
   • To delete a stage, select the resource to delete from the list and click the Delete button.
   • To edit a stage, select the resource to modify from the list and click the Edit button.

Stage Details

On the Stage Details page, you can view detailed information of the selected resource.

API Deployment Version Management

API Deployment Version Management tab allows you to view the API deployment history.

CORS (Cross-Origin Resource Sharing)

You can check the CORS list in the CORS tab.

Usage Policy

Usage Policy tab allows you to view the usage policies attached to the stage.

Create Authentication

JWT (JSON Web Token) is an open standard (RFC 7519) used for user authentication. JWT is a claim-based web token that stores user information as an encrypted token using the JSON format.

To generate a JWT, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. 1. Navigate to the Service Home page of API Gateway.

2. From the Service Home page, click the API Gateway > Authentication menu. 2. Navigate to the Authentication List page.

3. On the Authentication List page, click the Create JSON Web Token button. 3. JSON Web Token Generation Navigate to the popup window.

   • Enter or select the required information.

     Category	Required status	Detailed description
     JWT name	Required	Enter token name must start with a lowercase English letter and must not end with a special character (-), using lowercase letters, numbers, and special characters (-) to enter 3 ~ 50 characters
     Stage to connect	Selection	After checking Use, select stage

     Table. Authentication creation information input items

4. After entering the information and making selections, click the Confirm button.

5. After checking the message in the notification popup, click the Confirm button. 5. Access Token Navigate to the notification popup window.

   • The token can be viewed only in the Access Token notification popup. * If needed, download the Access Token file.

6. Access Token After checking the message in the notification popup, click the Confirm button.

   • After creation is complete, verify the created resource in the authentication list.
   • To delete a token, select the resource to delete from the list and click the Delete button.
   • To edit a token, select Edit from the context menu of the resource you want to edit.

Create Access Control

You can add an allowed IP address to restrict API calls to a specific IP.

To create access control, follow the steps below.

1. All Services > Application Service > API Gateway Click the menu. 1. Navigate to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Access Control menu. 2. Navigate to the Access Control List page.

3. On the Access Control List page, click the Create Access Control button. 3. Create Access Control Go to the popup window.

   • Enter or select the required information.

     Category	Required	Detailed description
     Access control name	Required	Enter access control name that starts with a lowercase English letter and does not end with a special character (-), using lowercase letters, numbers, and special characters (-) with a length of 3 to 50 characters
     Public access allowed IP	required	Enter IPs to allow access ’,‘You can enter up to 100 using ‘,’
     Stage to connect	Selection	After checking Use, select stage
     Explanation	Selection	Enter extra access control info (≤50 chars)

     Table. Access Control Creation Information Input Items

4. When the information entry and selection are complete, click the Confirm button.

5. After checking the message in the notification popup, click the Confirm button.

   • Once creation is complete, verify the created resource in the access control list.
   • To delete an access control list, select the resource to remove from the list and click the Delete button. * The default access control cannot be deleted.
   • To modify access control, select Edit from the context menu of the resource you want to modify.

Terminate API

You can reduce operating costs by terminating the unused service. However, if you terminate the service, the currently operating service may be stopped immediately, so you should proceed with the termination only after fully considering the impact that may arise from the service interruption.

To cancel the API, follow these steps.

1. All Services > Application Service > API Gateway Click the menu. 1. Navigate to the Service Home page of API Gateway.
2. On the Service Home page, click the API menu. 2. Go to the API list page.
3. On the API List page, select the resource to cancel and click the Service Termination button.
4. After the termination is complete, check on the API List page whether the resource has been terminated.

Using Report

You can check API traffic, performance, and error status.

To use the Report, follow these steps.

1. All Services > Application Service > API Gateway Click the menu. 1. Go to the Service Home page of API Gateway.
2. On the Service Home page, click the API Gateway > Report menu. 2. Go to the Report page.
   • Enter or select the required information.

3. After completing the information entry and selection, you can view the Report information.

Create Usage Policy

The usage policy is established to ensure efficient allocation of server resources, maintain service stability, prevent unnecessary traffic, and avoid misuse.

To create a usage policy, follow these steps.

1. All Services > Application Service > API Gateway menu, click it. 1. Go to the Service Home page of API Gateway.
2. On the Service Home page, click the API Gateway > Usage Policy menu. 2. Go to the Usage Policy page.
3. On the Usage Policy page, click the Create Usage Policy button. 3. Navigate to the Create Usage Policy page.
   • Enter or select the required information.

4. When the information entry and selection are complete, click the Complete button.
5. After checking the message in the notification popup, click the Confirm button.
   • Once creation is complete, check the resources you created in the usage policy list.

Create API Key

An API key is used to identify which user or app is calling the API. It is primarily used to limit usage according to the usage policy.

To create an API Key, follow these steps.

1. All Services > Application Service > API Gateway menu, click. 1. Go to the Service Home page of API Gateway.
2. On the Service Home page, click the API Gateway > Usage Policy menu. 2. Go to the Usage Policy page.
3. Click the usage policy in the list. 3. Navigate to the Usage Policy Details page.
4. On the Usage Policy Details page, click the Create API Key button. 4. Add API Key Navigate to the popup window.
   • Enter or select the required information.

4. After entering the information and making selections, click the Confirm button.
5. After checking the message in the notification popup, click the Confirm button.
   • When creation is complete, check the created resources on the Usage Policy Details page.

Create Resource Policy

Resource-based policies can fundamentally block unauthorized access and enhance the security level of the service.

To create a resource policy, follow these steps.

1. All Services > Application Service > API Gateway Click the menu. 1. Go to the Service Home page of API Gateway.
2. On the Service Home page, click the API Gateway > Resource Policy menu. 2. Navigate to the Resource Policy page.
3. Resource Policy page, click the Create Resource Policy button. 3. Navigate to the Create Resource Policy page.
   • In the Service Information Input area, enter or select the required information.

4. When the information entry and selection are complete, click the Complete button.
5. After checking the message in the notification popup, click the Confirm button.
   • When creation is complete, you can review, modify, or delete the resource policy.