A Private Network allows you to interconnect your Scaleway resources in an isolated and private network. Network reachability is limited to resources that are on the same Private Network. Note that a resource can be a part of multiple private networks.
List Private Networks
List existing Private Networks in the specified region. By default, the Private Networks returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
path Parameters
regionThe region you want to target
query Parameters
order_bySort order of the returned Private Networks.
pagePage number to return, from the paginated results.
page_sizeMaximum number of Private Networks to return per page.
nameName to filter for. Only Private Networks with names containing this string will be returned.
tagsTags to filter for. Only Private Networks with one or more matching tags will be returned.
organization_idOrganization ID to filter for. Only Private Networks belonging to this Organization will be returned. (UUID format)
project_idProject ID to filter for. Only Private Networks belonging to this Project will be returned. (UUID format)
private_network_idsPrivate Network IDs to filter for. Only Private Networks with one of these IDs will be returned.
vpc_idVPC ID to filter for. Only Private Networks belonging to this VPC will be returned. (UUID format)
dhcp_enabledDHCP status to filter for. When true, only Private Networks with managed DHCP enabled will be returned.
List Private Networks › Responses
total_countCreate a Private Network
Create a new Private Network. Once created, you can attach Scaleway resources which are in the same region.
path Parameters
regionThe region you want to target
Create a Private Network › Request Body
nameName for the Private Network.
project_idScaleway Project in which to create the Private Network. (UUID format)
tagsTags for the Private Network.
subnetsPrivate Network subnets CIDR. (IP network)
vpc_idVPC in which to create the Private Network. (UUID format)
default_route_propagation_enabledDefines whether default v4 and v6 routes are propagated for this Private Network.
Create a Private Network › Responses
idPrivate Network ID. (UUID format)
namePrivate Network name.
organization_idScaleway Organization the Private Network belongs to. (UUID format)
project_idScaleway Project the Private Network belongs to. (UUID format)
regionRegion in which the Private Network is available.
tagsTags of the Private Network.
created_atDate the Private Network was created. (RFC 3339 format)
updated_atDate the Private Network was last modified. (RFC 3339 format)
Private Network subnets.
vpc_idVPC the Private Network belongs to. (UUID format)
dhcp_enabledDefines whether managed DHCP is enabled for this Private Network.
default_route_propagation_enabledDefines whether default v4 and v6 routes are propagated for this Private Network.
Get a Private Network
Retrieve information about an existing Private Network, specified by its Private Network ID. Its full details are returned in the response object.
path Parameters
regionThe region you want to target
private_network_idPrivate Network ID. (UUID format)
Get a Private Network › Responses
idPrivate Network ID. (UUID format)
namePrivate Network name.
organization_idScaleway Organization the Private Network belongs to. (UUID format)
project_idScaleway Project the Private Network belongs to. (UUID format)
regionRegion in which the Private Network is available.
tagsTags of the Private Network.
created_atDate the Private Network was created. (RFC 3339 format)
updated_atDate the Private Network was last modified. (RFC 3339 format)
Private Network subnets.
vpc_idVPC the Private Network belongs to. (UUID format)
dhcp_enabledDefines whether managed DHCP is enabled for this Private Network.
default_route_propagation_enabledDefines whether default v4 and v6 routes are propagated for this Private Network.
Delete a Private Network
Delete an existing Private Network. Note that you must first detach all resources from the network, in order to delete it.
path Parameters
regionThe region you want to target
private_network_idPrivate Network ID. (UUID format)
Delete a Private Network › Responses
Update Private Network
Update parameters (such as name or tags) of an existing Private Network, specified by its Private Network ID.
path Parameters
regionThe region you want to target
private_network_idPrivate Network ID. (UUID format)
Update Private Network › Request Body
nameName for the Private Network.
tagsTags for the Private Network.
default_route_propagation_enabledDefines whether default v4 and v6 routes are propagated for this Private Network.
Update Private Network › Responses
idPrivate Network ID. (UUID format)
namePrivate Network name.
organization_idScaleway Organization the Private Network belongs to. (UUID format)
project_idScaleway Project the Private Network belongs to. (UUID format)
regionRegion in which the Private Network is available.
tagsTags of the Private Network.
created_atDate the Private Network was created. (RFC 3339 format)
updated_atDate the Private Network was last modified. (RFC 3339 format)
Private Network subnets.
vpc_idVPC the Private Network belongs to. (UUID format)
dhcp_enabledDefines whether managed DHCP is enabled for this Private Network.
default_route_propagation_enabledDefines whether default v4 and v6 routes are propagated for this Private Network.
Enable DHCP on a Private Network
Enable DHCP managed on an existing Private Network. Note that you will not be able to deactivate it afterwards.
path Parameters
regionThe region you want to target
private_network_idPrivate Network ID. (UUID format)
Enable DHCP on a Private Network › Responses
idPrivate Network ID. (UUID format)
namePrivate Network name.
organization_idScaleway Organization the Private Network belongs to. (UUID format)
project_idScaleway Project the Private Network belongs to. (UUID format)
regionRegion in which the Private Network is available.
tagsTags of the Private Network.
created_atDate the Private Network was created. (RFC 3339 format)
updated_atDate the Private Network was last modified. (RFC 3339 format)
Private Network subnets.
vpc_idVPC the Private Network belongs to. (UUID format)
dhcp_enabledDefines whether managed DHCP is enabled for this Private Network.
default_route_propagation_enabledDefines whether default v4 and v6 routes are propagated for this Private Network.