To use the API, API endpoint and token are required. Refer to API usage preparations to prepare the information required to use the API.
For Internet Gateway APIs, the network type endpoint is used. For more details, see serviceCatalogfrom the response of token issuance.
| Type | Region | Endpoint |
|---|---|---|
| network | Korea (Pangyo) Region Korea (Pyeongchon) Region Japan (Tokyo) Region United States (California) region |
https://kr1-api-network-infrastructure.nhncloudservice.com https://kr2-api-network-infrastructure.nhncloudservice.com https://jp1-api-network-infrastructure.nhncloudservice.com https://us1-api-network-infrastructure.nhncloudservice.com |
In each API response, you may find fields that are not specified within this guide. Those fields are for NHN Cloud internal usage, so refrain from using them because they may be changed without prior notice.
When creating an Internet Gateway, you must specify the ID of the external network to connect through the Internet Gateway.
The available external networks can be queried by specifying the router:external=true query to the VPC list view API.
GET /v2.0/vpcs?router:external=true
Returns a list of available internet gateways.
GET /v2.0/internetgateways
X-Auth-Token: {tokenId}
This API does not require a request body.
| Name | Type | Format | Required | Description |
|---|---|---|---|---|
| tokenId | Header | String | O | Token ID |
| tenant_id | Query | String | - | The tenant to which the internet gateway to look up belongs |
| id | Query | UUID | - | Internet gateway ID to look up |
| name | Query | String | - | Internet gateway name to look up |
| external_network_id | Query | UUID | - | The ID of the external network to which the internet gateway is connected. |
| routingtable_id | Query | UUID | - | The ID of the routing table associated with the internet gateway to look up. |
| Name | Type | Format | Description |
|---|---|---|---|
| internetgateways | Body | Array | List of Internet Gateway Information Objects |
| internetgateway.id | Body | UUID | Internet gateway ID |
| internetgateway.name | Body | String | Internet gateway name |
| internetgateway.external_network_id | Body | UUID | The ID of the external network to which the internet gateway is connected. |
| internetgateway.routingtable_id | Body | UUID | The ID of the routing table that the internet gateway is associated with when connected to a routing table |
| internetgateway.state | Body | String | The status of the Internet Gateway. available: Operating normallyunavailable: Not in use; not connected to a routing tablemigrating: Being moved to another internet gateway server for maintenanceERROR: Connected to a routing table but not functioning properly |
| internetgateway.create_time | Body | Date | Internet gateway creation time (UTC) |
| internetgateway.tenant_id | Body | String | The tenant ID to which the internet gateway belongs |
| internetgateway.migrate_status | Body | String | Processing status when migrating internet gateways due to maintenancenone: Not migrating or migration has completedunbinding_progress: Being removed from existing internet gateway serverunbinding_error: Error occurred while removing from existing internet gateway serverbinding_progress: Being configured on the new internet gateway serverbinding_error: Error occurred while configuring on the new internet gateway server |
| internetgateway.migrate_error | Body | String | Error messages during the internet gateway migration for maintenance |
{
"internetgateways": [
{
"id": "71f8e19a-8af3-4d3f-9b0e-b45a547fd7a7",
"name": "ig-7ef985c1-8568",
"external_network_id": "50687905-7b9d-423a-b929-ab8b296a7f35",
"routingtable_id": "7ef985c1-8568-4faa-a1ce-6a7116ba0e4d",
"state": "available",
"create_time": "2025-02-11 00:44:18",
"tenant_id": "130f20670ac34949b64b10ad8a5989c8",
"migrate_status": "none",
"migrate_error": null
}
]
}
Looks up the specified internet gateway.
GET /v2.0/internetgateways/{internetgatewayId}
X-Auth-Token: {tokenId}
This API does not require a request body.
| Name | Type | Format | Required | Description |
|---|---|---|---|---|
| internetgatewayId | URL | UUID | O | Routing table ID to query |
| tokenId | Header | String | O | Token ID |
| Name | Type | Format | Description |
|---|---|---|---|
| internetgateway | Body | Array | Internet Gateway Information Object |
| internetgateway.id | Body | UUID | Internet gateway ID |
| internetgateway.name | Body | String | Internet gateway name |
| internetgateway.external_network_id | Body | UUID | The ID of the external network to which the Internet gateway is connected. |
| internetgateway.routingtable_id | Body | UUID | The ID of the routing table that the Internet Gateway is associated with when connected to a routing table |
| internetgateway.state | Body | String | The status of the Internet Gateway. available: Operating normallyunavailable: Not in use; not connected to a routing tablemigrating: Being moved to another internet gateway server for maintenanceERROR: Connected to a routing table but not functioning properly |
| internetgateway.create_time | Body | Date | Internet gateway creation time (UTC) |
| internetgateway.tenant_id | Body | String | The tenant ID to which the internet gateway belongs |
| internetgateway.migrate_status | Body | String | Processing status when migrating internet gateways due to maintenancenone: not moving or the move is completeunbinding_progress: Status of unbinding from existing internet gateway serversunbinding_error: Error uninstalling from existing internet gateway serverbinding_progress: Status of configuration on the new internet gateway serverbinding_error: Error configuring on new internet gateway server |
| internetgateway.migrate_error | Body | String | Error messages during the internet gateway migration for maintenance |
{
"internetgateway": {
"id": "71f8e19a-8af3-4d3f-9b0e-b45a547fd7a7",
"name": "ig-7ef985c1-8568",
"external_network_id": "50687905-7b9d-423a-b929-ab8b296a7f35",
"routingtable_id": "7ef985c1-8568-4faa-a1ce-6a7116ba0e4d",
"state": "available",
"create_time": "2025-02-11 00:44:18",
"tenant_id": "130f20670ac34949b64b10ad8a5989c8",
"migrate_status": "none",
"migrate_error": null
}
}
Create a new internet gateway.
POST /v2.0/internetgateways
X-Auth-Token: {tokenId}
| Name | Type | Format | Required | Description |
|---|---|---|---|---|
| tokenId | Header | String | O | Token ID |
| internetgateway | Body | Object | O | Internet gateway information object to create |
| internetgateway.name | Body | String | O | Internet gateway name |
| internetgateway.external_network_id | Body | O | UUID | The external network ID for the internet gateway to connect to |
| Name | Type | Format | Description |
|---|---|---|---|
| internetgateway | Body | Array | Internet Gateway Information Object |
| internetgateway.id | Body | UUID | Internet gateway ID |
| internetgateway.name | Body | String | Internet gateway name |
| internetgateway.external_network_id | Body | UUID | The ID of the external network to which the Internet gateway is connected. |
| internetgateway.routingtable_id | Body | UUID | The ID of the routing table that the Internet Gateway is associated with when connected to a routing table |
| internetgateway.state | Body | String | The status of the Internet Gateway. available: Operating normallyunavailable: Not in use; not connected to a routing tablemigrating: Being moved to another internet gateway server for maintenanceERROR: Connected to a routing table but not functioning properly |
| internetgateway.create_time | Body | Date | Internet gateway creation time (UTC) |
| internetgateway.tenant_id | Body | String | The tenant ID to which the Internet Gateway belongs |
| internetgateway.migrate_status | Body | String | Processing status when migrating internet gateways due to maintenancenone: not moving or the move is completeunbinding_progress: Status of unbinding from existing internet gateway serversunbinding_error: Error uninstalling from existing internet gateway serverbinding_progress: Status of configuration on the new internet gateway serverbinding_error: Error configuring on new internet gateway server |
| internetgateway.migrate_error | Body | String | Error messages during the internet gateway migration for maintenance |
{
"internetgateway": {
"id": "71f8e19a-8af3-4d3f-9b0e-b45a547fd7a7",
"name": "ig-7ef985c1-8568",
"external_network_id": "50687905-7b9d-423a-b929-ab8b296a7f35",
"state": "unavailable",
"create_time": "2025-02-11 00:44:18",
"tenant_id": "130f20670ac34949b64b10ad8a5989c8",
"migrate_status": "none"
}
}
Delete the internet gateway.
DELETE /v2.0/internetgateways/{internetgatewayId}
X-Auth-Token: {tokenId}
This API does not require a request body.
| Name | Type | Format | Required | Description |
|---|---|---|---|---|
| internetgatewayId | URL | UUID | O | Routing table to delete |
| tokenId | Header | String | O | Token ID |
This API does not return a response body.