Scaleway logo
VPC API
VPC API

Schemas

Download schema

scaleway.vpc.v2.AclRule

protocol
​scaleway.vpc.v2.AclRule.Protocol · enum · required

Protocol to which this rule applies.

Enum values:
ANY
TCP
UDP
ICMP
Default: ANY
source
​string · required

Source IP range to which this rule applies (CIDR notation with subnet mask). (IP network)

src_port_low
​integer · uint32 · required

Starting port of the source port range to which this rule applies (inclusive).

src_port_high
​integer · uint32 · required

Ending port of the source port range to which this rule applies (inclusive).

destination
​string · required

Destination IP range to which this rule applies (CIDR notation with subnet mask). (IP network)

dst_port_low
​integer · uint32 · required

Starting port of the destination port range to which this rule applies (inclusive).

dst_port_high
​integer · uint32 · required

Ending port of the destination port range to which this rule applies (inclusive).

action
​scaleway.vpc.v2.Action · enum · required

Policy to apply to the packet.

Enum values:
unknown_action
accept
drop
Default: unknown_action
description
​string | null · required

Rule description.

scaleway.vpc.v2.AclRule.Protocol

string · enum
Enum values:
ANY
TCP
UDP
ICMP
Default: ANY

scaleway.vpc.v2.Action

string · enum
Enum values:
unknown_action
accept
drop
Default: unknown_action

scaleway.vpc.v2.AddPrivateNetworkObjectStoragePrivateAccessResponse

vpc_id
​string

ID of the VPC containing the Object Storage private access. (UUID format)

private_network_ids
​string[]

IDs of the Private Networks associated with the Object Storage private access.

scaleway.vpc.v2.GetAclResponse

default_policy
​scaleway.vpc.v2.Action · enum
Enum values:
unknown_action
accept
drop
Default: unknown_action

scaleway.vpc.v2.IngressRule

id
​string

ID of the ingress rule. (UUID format)

srn
​string

The SRN of the ingress rule.

vpc_id
​string

ID of the VPC this rule belongs to. (UUID format)

created_at
​string | null · date-time

Date the ingress rule was created. (RFC 3339 format)

updated_at
​string | null · date-time

Date the ingress rule was last modified. (RFC 3339 format)

is_ipv6
​boolean

Whether this rule applies to IPv4 or IPv6 traffic.

source
​string

Source network to apply this rule on. (IP network)

nexthop_resource_ip
​string

IP of the local resource to redirect ingress traffic to. (IP address)

nexthop_private_network_id
​string

ID of the Private Network the destination resource is in. (UUID format)

description
​string | null

Description of this ingress rule.

tags
​string[]

Tags of this ingress rule.

organization_id
​string

Scaleway Organization the ingress rule belongs to. (UUID format)

project_id
​string

Scaleway Project the ingress rule belongs to. (UUID format)

region
​string

Region of the ingress rule.

scaleway.vpc.v2.ListIngressRulesRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
source_asc
source_desc
prefix_len_asc
prefix_len_desc
Default: created_at_asc

scaleway.vpc.v2.ListIngressRulesResponse

total_count
​integer · uint64

scaleway.vpc.v2.ListPrivateNetworksRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.vpc.v2.ListPrivateNetworksResponse

​scaleway.vpc.v2.PrivateNetwork[]
total_count
​integer · uint32

scaleway.vpc.v2.ListSubnetOverlapsRequest.OrderBy

string · enum
Enum values:
subnet_asc
subnet_desc
target_subnet_asc
target_subnet_desc
Default: subnet_asc

scaleway.vpc.v2.ListSubnetOverlapsResponse

total_count
​integer · uint64

scaleway.vpc.v2.ListSubnetOverlapsResponse.SubnetOverlap

subnet_id
​string

(UUID format)

subnet
​string

(IP network)

target_subnet_id
​string

(UUID format)

target_subnet
​string

(IP network)

scaleway.vpc.v2.ListSubnetsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.vpc.v2.ListSubnetsResponse

total_count
​integer · uint32

scaleway.vpc.v2.ListVPCConnectorsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.vpc.v2.ListVPCConnectorsResponse

​scaleway.vpc.v2.VPCConnector[]
total_count
​integer · uint32

scaleway.vpc.v2.ListVPCsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.vpc.v2.ListVPCsResponse

total_count
​integer · uint32

scaleway.vpc.v2.PrivateNetwork

id
​string

Private Network ID. (UUID format)

srn
​string

The SRN of the private network.

name
​string

Private Network name.

organization_id
​string

Scaleway Organization the Private Network belongs to. (UUID format)

project_id
​string

Scaleway Project the Private Network belongs to. (UUID format)

region
​string

Region in which the Private Network is available.

tags
​string[]

Tags of the Private Network.

created_at
​string | null · date-time

Date the Private Network was created. (RFC 3339 format)

updated_at
​string | null · date-time

Date the Private Network was last modified. (RFC 3339 format)

Private Network subnets.

vpc_id
​string

VPC the Private Network belongs to. (UUID format)

dhcp_enabled
​boolean

Defines whether managed DHCP is enabled for this Private Network.

default_route_propagation_enabled
​boolean

Defines whether default v4 and v6 routes are propagated for this Private Network.

has_object_storage_private_access
​boolean

Defines whether this Private Network is enabled for Object Storage private access.

scaleway.vpc.v2.Route

id
​string

Route ID. (UUID format)

srn
​string

The SRN of the route.

description
​string

Route description.

tags
​string[]

Tags of the Route.

vpc_id
​string

VPC the Route belongs to. (UUID format)

destination
​string

Destination of the Route. (IP network)

nexthop_resource_id
​string | null

ID of the nexthop resource. (UUID format)

nexthop_private_network_id
​string | null

ID of the nexthop private network. (UUID format)

nexthop_vpc_connector_id
​string | null

ID of the nexthop VPC connector. (UUID format)

created_at
​string | null · date-time

Date the Route was created. (RFC 3339 format)

updated_at
​string | null · date-time

Date the Route was last modified. (RFC 3339 format)

is_read_only
​boolean

Defines whether the route can be modified or deleted by the user.

type
​scaleway.vpc.v2.RouteType · enum

Type of the Route.

Enum values:
unknown_route_type
subnet
default
custom
interlink
s2s_vpn
Default: unknown_route_type
region
​string

Region of the Route.

scaleway.vpc.v2.RouteType

string · enum
Enum values:
unknown_route_type
subnet
default
custom
interlink
s2s_vpn
Default: unknown_route_type

scaleway.vpc.v2.SetAclResponse

default_policy
​scaleway.vpc.v2.Action · enum
Enum values:
unknown_action
accept
drop
Default: unknown_action

scaleway.vpc.v2.SetPrivateNetworksObjectStoragePrivateAccessResponse

vpc_id
​string

ID of the VPC containing the Object Storage private access. (UUID format)

private_network_ids
​string[]

IDs of the Private Networks associated with the Object Storage private access.

scaleway.vpc.v2.Subnet

id
​string

ID of the subnet. (UUID format)

srn
​string

The SRN of the subnet.

created_at
​string | null · date-time

Subnet creation date. (RFC 3339 format)

updated_at
​string | null · date-time

Subnet last modification date. (RFC 3339 format)

subnet
​string

Subnet CIDR. (IP network)

project_id
​string

Scaleway Project the subnet belongs to. (UUID format)

private_network_id
​string

Private Network the subnet belongs to. (UUID format)

vpc_id
​string

VPC the subnet belongs to. (UUID format)

region
​string

Region in which the Subnet can be used.

scaleway.vpc.v2.VPC

id
​string

VPC ID. (UUID format)

srn
​string

The SRN of the VPC.

name
​string

VPC name.

organization_id
​string

Scaleway Organization the VPC belongs to. (UUID format)

project_id
​string

Scaleway Project the VPC belongs to. (UUID format)

region
​string

Region of the VPC.

tags
​string[]

Tags for the VPC.

is_default
​boolean

Defines whether the VPC is the default one for its Project.

created_at
​string | null · date-time

Date the VPC was created. (RFC 3339 format)

updated_at
​string | null · date-time

Date the VPC was last modified. (RFC 3339 format)

private_network_count
​integer · uint32

Number of Private Networks within this VPC.

routing_enabled
​boolean

Defines whether the VPC routes traffic between its Private Networks.

custom_routes_propagation_enabled
​boolean

Defines whether the VPC advertises custom routes between its Private Networks.

transitivity_enabled
​boolean

Defines whether the VPC allows packets from peered VPCs to transit through.

object_storage_private_access_enabled
​boolean

Defines whether the Object Storage private access is enabled for the VPC.

scaleway.vpc.v2.VPCConnector

id
​string

VPC connector ID. (UUID format)

srn
​string

The SRN of the VPC connector.

name
​string

VPC connector name.

organization_id
​string

Scaleway Organization the VPC connector belongs to. (UUID format)

project_id
​string

Scaleway Project the VPC connector belongs to. (UUID format)

vpc_id
​string

VPC the VPC connector belongs to (origin VPC). (UUID format)

target_vpc_id
​string

VPC with which the VPC connector is peered (target VPC). (UUID format)

status
​scaleway.vpc.v2.VPCConnectorStatus · enum

Status of the VPC connector.

Enum values:
unknown_vpc_connector_status
orphan
peered
conflict
Default: unknown_vpc_connector_status

Peer info of target VPC. Available when status is Peered.

region
​string

Region of the VPC connector.

tags
​string[]

Tags for the VPC connector.

created_at
​string | null · date-time

Date the VPC connector was created. (RFC 3339 format)

updated_at
​string | null · date-time

Date the VPC connector was last modified. (RFC 3339 format)

scaleway.vpc.v2.VPCConnector.PeerInfo

organization_id
​string

(UUID format)

project_id
​string

(UUID format)

vpc_name
​string

scaleway.vpc.v2.VPCConnectorStatus

string · enum
Enum values:
unknown_vpc_connector_status
orphan
peered
conflict
Default: unknown_vpc_connector_status