Gateway Networks

A Gateway Network represents the connection of a Private Network to a Public Gateway.

List Public Gateway connections to Private Networks

GET

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks

List the connections between Public Gateways and Private Networks (a connection = a GatewayNetwork). You can choose to filter by gateway-id to list all Private Networks attached to the specified Public Gateway, or by private_network_id to list all Public Gateways attached to the specified Private Network. Other query parameters are also available. The result is an array of GatewayNetwork objects, each giving details of the connection between a given Public Gateway and a given Private Network.

List Public Gateway connections to Private Networks › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

List Public Gateway connections to Private Networks › query Parameters

order_by

string · enum

Order in which to return results.

Enum values:

created_at_asc

created_at_desc

status_asc

status_desc

Default: created_at_asc

page

integer · int32

Page number.

page_size

integer · uint32

GatewayNetworks per page.

status

scaleway.vpc_gw.v2.GatewayNetwork.Status[]

Filter for GatewayNetworks with these status. Use unknown to include all statuses.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

gateway_ids

string[]

Filter for GatewayNetworks connected to these gateways.

private_network_ids

string[]

Filter for GatewayNetworks connected to these Private Networks.

masquerade_enabled

boolean

Filter for GatewayNetworks with this enable_masquerade setting.

List Public Gateway connections to Private Networks › Responses

200

scaleway.vpc_gw.v2.ListGatewayNetworksResponse

scaleway.vpc_gw.v2.GatewayNetwork[]

GatewayNetworks on this page.

total_count

integer · uint64

Total GatewayNetworks count matching the filter.

Attach a Public Gateway to a Private Network

POST

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks

Attach a specific Public Gateway to a specific Private Network (create a GatewayNetwork). You can configure parameters for the connection including whether to enable masquerade (dynamic NAT), and more.

Attach a Public Gateway to a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Attach a Public Gateway to a Private Network › Request Body

gateway_id

string

Public Gateway to connect. (UUID format)

private_network_id

string

Private Network to connect. (UUID format)

enable_masquerade

boolean

Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork.

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

Attach a Public Gateway to a Private Network › Responses

200

scaleway.vpc_gw.v2.GatewayNetwork

id

string

ID of the Public Gateway-Private Network connection. (UUID format)

created_at

string · date-time

Connection creation date. (RFC 3339 format)

updated_at

string · date-time

Connection last modification date. (RFC 3339 format)

gateway_id

string

ID of the connected Public Gateway. (UUID format)

private_network_id

string

ID of the connected Private Network. (UUID format)

mac_address

string

MAC address of the gateway in the Private Network (if the gateway is up and running).

masquerade_enabled

boolean

Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT).

status

string · enum

Current status of the Public Gateway's connection to the Private Network.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

Default: unknown_status

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

zone

string

Zone of the GatewayNetwork connection.

POST/vpc-gw/v2/zones/{zone}/gateway-networks

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enable_masquerade": false,
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
    "push_default_route": false
  }' \
  "https://api.scaleway.com/vpc-gw/v2/zones/{zone}/gateway-networks"

Example Request Body

{
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "enable_masquerade": true,
  "push_default_route": true,
  "ipam_ip_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "mac_address": "mac_address",
  "masquerade_enabled": true,
  "status": "unknown_status",
  "push_default_route": true,
  "ipam_ip_id": "6170692e-7363-616c-6577-61792e636f6d",
  "zone": "zone"
}

json

application/json

Get a Public Gateway connection to a Private Network

GET

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks/{gateway_network_id}

Get details of a given connection between a Public Gateway and a Private Network (this connection = a GatewayNetwork), specified by its gateway_network_id. The response object contains details of the connection including the IDs of the Public Gateway and Private Network, the dates the connection was created/updated and its configuration settings.

Get a Public Gateway connection to a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_network_id

string · required

ID of the GatewayNetwork to fetch. (UUID format)

Get a Public Gateway connection to a Private Network › Responses

200

scaleway.vpc_gw.v2.GatewayNetwork

id

string

ID of the Public Gateway-Private Network connection. (UUID format)

created_at

string · date-time

Connection creation date. (RFC 3339 format)

updated_at

string · date-time

Connection last modification date. (RFC 3339 format)

gateway_id

string

ID of the connected Public Gateway. (UUID format)

private_network_id

string

ID of the connected Private Network. (UUID format)

mac_address

string

MAC address of the gateway in the Private Network (if the gateway is up and running).

masquerade_enabled

boolean

Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT).

status

string · enum

Current status of the Public Gateway's connection to the Private Network.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

Default: unknown_status

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

zone

string

Zone of the GatewayNetwork connection.

Detach a Public Gateway from a Private Network

DELETE

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks/{gateway_network_id}

Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id.

Detach a Public Gateway from a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_network_id

string · required

ID of the GatewayNetwork to delete. (UUID format)

Detach a Public Gateway from a Private Network › Responses

200

scaleway.vpc_gw.v2.GatewayNetwork

id

string

ID of the Public Gateway-Private Network connection. (UUID format)

created_at

string · date-time

Connection creation date. (RFC 3339 format)

updated_at

string · date-time

Connection last modification date. (RFC 3339 format)

gateway_id

string

ID of the connected Public Gateway. (UUID format)

private_network_id

string

ID of the connected Private Network. (UUID format)

mac_address

string

MAC address of the gateway in the Private Network (if the gateway is up and running).

masquerade_enabled

boolean

Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT).

status

string · enum

Current status of the Public Gateway's connection to the Private Network.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

Default: unknown_status

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

zone

string

Zone of the GatewayNetwork connection.

Update a Public Gateway's connection to a Private Network

PATCH

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks/{gateway_network_id}

Update the configuration parameters of a connection between a given Public Gateway and Private Network (the connection = a GatewayNetwork). Updatable parameters include whether to enable traffic masquerade (dynamic NAT).

Update a Public Gateway's connection to a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_network_id

string · required

ID of the GatewayNetwork to update. (UUID format)

Update a Public Gateway's connection to a Private Network › Request Body

enable_masquerade

boolean

Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork.

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

Update a Public Gateway's connection to a Private Network › Responses

200

scaleway.vpc_gw.v2.GatewayNetwork

id

string

ID of the Public Gateway-Private Network connection. (UUID format)

created_at

string · date-time

Connection creation date. (RFC 3339 format)

updated_at

string · date-time

Connection last modification date. (RFC 3339 format)

gateway_id

string

ID of the connected Public Gateway. (UUID format)

private_network_id

string

ID of the connected Private Network. (UUID format)

mac_address

string

MAC address of the gateway in the Private Network (if the gateway is up and running).

masquerade_enabled

boolean

Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT).

status

string · enum

Current status of the Public Gateway's connection to the Private Network.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

Default: unknown_status

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

zone

string

Zone of the GatewayNetwork connection.

PATCH/vpc-gw/v2/zones/{zone}/gateway-networks/{gateway_network_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/vpc-gw/v2/zones/{zone}/gateway-networks/{gateway_network_id}"

Example Request Body

{
  "enable_masquerade": true,
  "push_default_route": true,
  "ipam_ip_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "mac_address": "mac_address",
  "masquerade_enabled": true,
  "status": "unknown_status",
  "push_default_route": true,
  "ipam_ip_id": "6170692e-7363-616c-6577-61792e636f6d",
  "zone": "zone"
}

json

application/json

Gateways PAT Rules

List Public Gateway connections to Private Networks

GET

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks

List Public Gateway connections to Private Networks › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

List Public Gateway connections to Private Networks › query Parameters

order_by

string · enum

Order in which to return results.

Enum values:

created_at_asc

created_at_desc

status_asc

status_desc

Default: created_at_asc

page

integer · int32

Page number.

page_size

integer · uint32

GatewayNetworks per page.

status

scaleway.vpc_gw.v2.GatewayNetwork.Status[]

Filter for GatewayNetworks with these status. Use unknown to include all statuses.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

gateway_ids

string[]

Filter for GatewayNetworks connected to these gateways.

private_network_ids

string[]

Filter for GatewayNetworks connected to these Private Networks.

masquerade_enabled

boolean

Filter for GatewayNetworks with this enable_masquerade setting.

List Public Gateway connections to Private Networks › Responses

200

scaleway.vpc_gw.v2.ListGatewayNetworksResponse

scaleway.vpc_gw.v2.GatewayNetwork[]

GatewayNetworks on this page.

total_count

integer · uint64

Total GatewayNetworks count matching the filter.

Attach a Public Gateway to a Private Network

POST

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks

Attach a Public Gateway to a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Attach a Public Gateway to a Private Network › Request Body

gateway_id

string

Public Gateway to connect. (UUID format)

private_network_id

string

Private Network to connect. (UUID format)

enable_masquerade

boolean

Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork.

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

Attach a Public Gateway to a Private Network › Responses

200

scaleway.vpc_gw.v2.GatewayNetwork

id

string

ID of the Public Gateway-Private Network connection. (UUID format)

created_at

string · date-time

Connection creation date. (RFC 3339 format)

updated_at

string · date-time

Connection last modification date. (RFC 3339 format)

gateway_id

string

ID of the connected Public Gateway. (UUID format)

private_network_id

string

ID of the connected Private Network. (UUID format)

mac_address

string

MAC address of the gateway in the Private Network (if the gateway is up and running).

masquerade_enabled

boolean

Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT).

status

string · enum

Current status of the Public Gateway's connection to the Private Network.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

Default: unknown_status

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

zone

string

Zone of the GatewayNetwork connection.

Get a Public Gateway connection to a Private Network

GET

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks/{gateway_network_id}

Get a Public Gateway connection to a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_network_id

string · required

ID of the GatewayNetwork to fetch. (UUID format)

Get a Public Gateway connection to a Private Network › Responses

200

scaleway.vpc_gw.v2.GatewayNetwork

id

string

ID of the Public Gateway-Private Network connection. (UUID format)

created_at

string · date-time

Connection creation date. (RFC 3339 format)

updated_at

string · date-time

Connection last modification date. (RFC 3339 format)

gateway_id

string

ID of the connected Public Gateway. (UUID format)

private_network_id

string

ID of the connected Private Network. (UUID format)

mac_address

string

MAC address of the gateway in the Private Network (if the gateway is up and running).

masquerade_enabled

boolean

Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT).

status

string · enum

Current status of the Public Gateway's connection to the Private Network.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

Default: unknown_status

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

zone

string

Zone of the GatewayNetwork connection.

Detach a Public Gateway from a Private Network

DELETE

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks/{gateway_network_id}

Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id.

Detach a Public Gateway from a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_network_id

string · required

ID of the GatewayNetwork to delete. (UUID format)

Detach a Public Gateway from a Private Network › Responses

200

scaleway.vpc_gw.v2.GatewayNetwork

id

string

ID of the Public Gateway-Private Network connection. (UUID format)

created_at

string · date-time

Connection creation date. (RFC 3339 format)

updated_at

string · date-time

Connection last modification date. (RFC 3339 format)

gateway_id

string

ID of the connected Public Gateway. (UUID format)

private_network_id

string

ID of the connected Private Network. (UUID format)

mac_address

string

MAC address of the gateway in the Private Network (if the gateway is up and running).

masquerade_enabled

boolean

Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT).

status

string · enum

Current status of the Public Gateway's connection to the Private Network.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

Default: unknown_status

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

zone

string

Zone of the GatewayNetwork connection.

Update a Public Gateway's connection to a Private Network

PATCH

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateway-networks/{gateway_network_id}

Update a Public Gateway's connection to a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_network_id

string · required

ID of the GatewayNetwork to update. (UUID format)

Update a Public Gateway's connection to a Private Network › Request Body

enable_masquerade

boolean

Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork.

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

Update a Public Gateway's connection to a Private Network › Responses

200

scaleway.vpc_gw.v2.GatewayNetwork

id

string

ID of the Public Gateway-Private Network connection. (UUID format)

created_at

string · date-time

Connection creation date. (RFC 3339 format)

updated_at

string · date-time

Connection last modification date. (RFC 3339 format)

gateway_id

string

ID of the connected Public Gateway. (UUID format)

private_network_id

string

ID of the connected Private Network. (UUID format)

mac_address

string

MAC address of the gateway in the Private Network (if the gateway is up and running).

masquerade_enabled

boolean

Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT).

status

string · enum

Current status of the Public Gateway's connection to the Private Network.

Enum values:

unknown_status

created

attaching

configuring

ready

detaching

Default: unknown_status

push_default_route

boolean

Enabling the default route also enables masquerading.

ipam_ip_id

string

Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. (UUID format)

zone

string

Zone of the GatewayNetwork connection.