Scaleway logo
Public Gateways API

scaleway.vpc_gw.v2.AddBastionAllowedIPsResponse

ip_ranges
​string[]

Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network)

scaleway.vpc_gw.v2.Gateway

id
​string

ID of the gateway. (UUID format)

srn
​string

The SRN of the gateway.

organization_id
​string

Owning Organization. (UUID format)

project_id
​string

Owning Project. (UUID format)

created_at
​string | null · date-time

Gateway creation date. (RFC 3339 format)

updated_at
​string | null · date-time

Gateway last modification date. (RFC 3339 format)

type
​string

Gateway type name (commercial offer).

bandwidth
​integer · uint64

Bandwidth available of the gateway.

status
​scaleway.vpc_gw.v2.Gateway.Status · enum

Current status of the gateway.

Enum values:
unknown_status
stopped
allocating
configuring
running
stopping
failed
deleting
Default: unknown_status
name
​string

Name of the gateway.

tags
​string[]

Tags associated with the gateway.

Public IPv4 address of the gateway.

​scaleway.vpc_gw.v2.GatewayNetwork[]

GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network).

version
​string | null

Version of the running gateway software.

can_upgrade_to
​string | null

Newly available gateway software version that can be updated to.

bastion_enabled
​boolean

Defines whether SSH bastion is enabled on the gateway.

bastion_port
​integer · uint32

Port of the SSH bastion.

smtp_enabled
​boolean

Defines whether SMTP traffic is allowed to pass through the gateway.

is_legacy
​boolean

Defines whether the gateway uses non-IPAM IP configurations.

bastion_allowed_ips
​string[]

Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network)

zone
​string

Zone of the gateway.

scaleway.vpc_gw.v2.Gateway.Status

string · enum
Enum values:
unknown_status
stopped
allocating
configuring
running
stopping
failed
deleting
Default: unknown_status

scaleway.vpc_gw.v2.GatewayNetwork

id
​string

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

srn
​string

The SRN of the gateway network.

created_at
​string | null · date-time

Connection creation date. (RFC 3339 format)

updated_at
​string | null · 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 | null

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
​scaleway.vpc_gw.v2.GatewayNetwork.Status · 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.

scaleway.vpc_gw.v2.GatewayNetwork.Status

string · enum
Enum values:
unknown_status
created
attaching
configuring
ready
detaching
Default: unknown_status

scaleway.vpc_gw.v2.GatewayType

name
​string

Public Gateway type name.

bandwidth
​integer · uint64

Bandwidth, in bps, of the Public Gateway. This is the public bandwidth to the outer Internet, and the internal bandwidth to each connected Private Networks.

zone
​string

Zone the Public Gateway type is available in.

scaleway.vpc_gw.v2.IP

id
​string

IP address ID. (UUID format)

srn
​string

The SRN of the ip.

organization_id
​string

Owning Organization. (UUID format)

project_id
​string

Owning Project. (UUID format)

created_at
​string | null · date-time

IP address creation date. (RFC 3339 format)

updated_at
​string | null · date-time

IP address last modification date. (RFC 3339 format)

tags
​string[]

Tags associated with the IP address.

address
​string

The IP address itself. (IP address)

reverse
​string | null

Reverse domain name for the IP address.

gateway_id
​string | null

Public Gateway associated with the IP address. (UUID format)

zone
​string

Zone of the IP address.

scaleway.vpc_gw.v2.ListGatewayNetworksRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
status_asc
status_desc
Default: created_at_asc

scaleway.vpc_gw.v2.ListGatewayNetworksResponse

​scaleway.vpc_gw.v2.GatewayNetwork[]

GatewayNetworks on this page.

total_count
​integer · uint64

Total GatewayNetworks count matching the filter.

scaleway.vpc_gw.v2.ListGatewayTypesResponse

Available types of Public Gateway.

scaleway.vpc_gw.v2.ListGatewaysRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
type_asc
type_desc
status_asc
status_desc
Default: created_at_asc

scaleway.vpc_gw.v2.ListGatewaysResponse

Gateways on this page.

total_count
​integer · uint64

Total count of gateways matching the filter.

scaleway.vpc_gw.v2.ListIPsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
address_asc
address_desc
reverse_asc
reverse_desc
Default: created_at_asc

scaleway.vpc_gw.v2.ListIPsResponse

IP addresses on this page.

total_count
​integer · uint64

Total count of IP addresses matching the filter.

scaleway.vpc_gw.v2.ListPatRulesRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
public_port_asc
public_port_desc
Default: created_at_asc

scaleway.vpc_gw.v2.ListPatRulesResponse

Array of PAT rules matching the filter.

total_count
​integer · uint64

Total count of PAT rules matching the filter.

scaleway.vpc_gw.v2.PatRule

id
​string

PAT rule ID. (UUID format)

srn
​string

The SRN of the PAT rule.

gateway_id
​string

Gateway the PAT rule applies to. (UUID format)

created_at
​string | null · date-time

PAT rule creation date. (RFC 3339 format)

updated_at
​string | null · date-time

PAT rule last modification date. (RFC 3339 format)

public_port
​integer · uint32

Public port to listen on.

private_ip
​string

Private IP address to forward data to. (IP address)

private_port
​integer · uint32

Private port to translate to.

protocol
​scaleway.vpc_gw.v2.PatRule.Protocol · enum

Protocol the rule applies to.

Enum values:
unknown_protocol
both
tcp
udp
Default: unknown_protocol
zone
​string

Zone of the PAT rule.

scaleway.vpc_gw.v2.PatRule.Protocol

string · enum
Enum values:
unknown_protocol
both
tcp
udp
Default: unknown_protocol

scaleway.vpc_gw.v2.SetBastionAllowedIPsResponse

ip_ranges
​string[]

Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network)

scaleway.vpc_gw.v2.SetPatRulesRequest.Rule

public_port
​integer · uint32

Public port to listen on. Public port to listen on. Uniquely identifies the rule, and a matching rule will be updated with the new parameters.

private_ip
​string

Private IP to forward data to. (IP address)

private_port
​integer · uint32

Private port to translate to.

protocol
​scaleway.vpc_gw.v2.PatRule.Protocol · enum

Protocol the rule should apply to.

Enum values:
unknown_protocol
both
tcp
udp
Default: unknown_protocol

scaleway.vpc_gw.v2.SetPatRulesResponse

List of PAT rules.