Private Networks

Download schema

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

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/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.

List Private Networks › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List Private Networks › query Parameters

order_by

scaleway.vpc.v2.ListPrivateNetworksRequest.OrderBy · enum

Sort order of the returned Private Networks.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Maximum number of Private Networks to return per page.

name

string

Name to filter for. Only Private Networks with names containing this string will be returned.

tags

string[]

Tags to filter for. Only Private Networks with one or more matching tags will be returned.

organization_id

string

Organization ID to filter for. Only Private Networks belonging to this Organization will be returned. (UUID format)

project_id

string

Project ID to filter for. Only Private Networks belonging to this Project will be returned. (UUID format)

private_network_ids

string[]

Private Network IDs to filter for. Only Private Networks with one of these IDs will be returned.

vpc_id

string

VPC ID to filter for. Only Private Networks belonging to this VPC will be returned. (UUID format)

dhcp_enabled

boolean

DHCP status to filter for. When true, only Private Networks with managed DHCP enabled will be returned.

object_storage_private_access_enabled

boolean

Filter by whether Object Storage private access is enabled. When set, only matching Private Networks will be returned.

List Private Networks › Responses

200

scaleway.vpc.v2.ListPrivateNetworksResponse

scaleway.vpc.v2.PrivateNetwork[]

total_count

integer · uint32

GET/vpc/v2/regions/{region}/private-networks

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/vpc/v2/regions/{region}/private-networks"

Example Responses

{
  "private_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "name": "name",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "region": "region",
      "tags": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "subnets": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "srn": "srn",
          "created_at": "2022-03-22T12:34:56.123456Z",
          "updated_at": "2022-03-22T12:34:56.123456Z",
          "subnet": "1.2.3.4/32",
          "project_id": "6170692e-7363-616c-6577-61792e636f6d",
          "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
          "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
          "region": "region"
        }
      ],
      "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
      "dhcp_enabled": true,
      "default_route_propagation_enabled": true,
      "has_object_storage_private_access": true
    }
  ],
  "total_count": 0
}

json

application/json

Create a Private Network

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/private-networks

Create a new Private Network. Once created, you can attach Scaleway resources which are in the same region.

Create a Private Network › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Create a Private Network › Request Body

name

string · required

Name for the Private Network.

project_id

string · required

Scaleway Project in which to create the Private Network. (UUID format)

tags

string[]

Tags for the Private Network.

subnets

string[]

Private Network subnets CIDR. (IP network)

vpc_id

string | null

VPC in which to create the Private Network. (UUID format)

default_route_propagation_enabled

boolean

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

Create a Private Network › Responses

200

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)

scaleway.vpc.v2.Subnet[]

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.

POST/vpc/v2/regions/{region}/private-networks

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "default_route_propagation_enabled": false,
    "name": "string",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d"
  }' \
  "https://api.scaleway.com/vpc/v2/regions/{region}/private-networks"

Example Request Body

{
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "tags": [
    "string"
  ],
  "subnets": [
    "1.2.3.4/32"
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "default_route_propagation_enabled": true
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "subnets": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "subnet": "1.2.3.4/32",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
      "region": "region"
    }
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "dhcp_enabled": true,
  "default_route_propagation_enabled": true,
  "has_object_storage_private_access": true
}

json

application/json

Get a Private Network

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/private-networks/{private_network_id}

Retrieve information about an existing Private Network, specified by its Private Network ID. Its full details are returned in the response object.

Get a Private Network › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

private_network_id

string · required

Private Network ID. (UUID format)

Get a Private Network › Responses

200

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)

scaleway.vpc.v2.Subnet[]

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.

GET/vpc/v2/regions/{region}/private-networks/{private_network_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/vpc/v2/regions/{region}/private-networks/{private_network_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "subnets": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "subnet": "1.2.3.4/32",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
      "region": "region"
    }
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "dhcp_enabled": true,
  "default_route_propagation_enabled": true,
  "has_object_storage_private_access": true
}

json

application/json

Delete a Private Network

DELETE

https://api.scaleway.com

/vpc/v2/regions/{region}/private-networks/{private_network_id}

Delete an existing Private Network. Note that you must first detach all resources from the network, in order to delete it.

Delete a Private Network › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

private_network_id

string · required

Private Network ID. (UUID format)

Delete a Private Network › Responses

No data returned

Update Private Network

PATCH

https://api.scaleway.com

/vpc/v2/regions/{region}/private-networks/{private_network_id}

Update parameters (such as name or tags) of an existing Private Network, specified by its Private Network ID.

Update Private Network › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

private_network_id

string · required

Private Network ID. (UUID format)

Update Private Network › Request Body

name

string | null

Name for the Private Network.

tags

array | null

Tags for the Private Network.

default_route_propagation_enabled

boolean | null

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

Update Private Network › Responses

200

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)

scaleway.vpc.v2.Subnet[]

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.

PATCH/vpc/v2/regions/{region}/private-networks/{private_network_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/vpc/v2/regions/{region}/private-networks/{private_network_id}"

Example Request Body

{
  "name": "name",
  "tags": [],
  "default_route_propagation_enabled": true
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "subnets": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "subnet": "1.2.3.4/32",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
      "region": "region"
    }
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "dhcp_enabled": true,
  "default_route_propagation_enabled": true,
  "has_object_storage_private_access": true
}

json

application/json

Enable DHCP on a Private Network

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/private-networks/{private_network_id}/enable-dhcp

Enable DHCP managed on an existing Private Network. Note that you will not be able to deactivate it afterwards.

Enable DHCP on a Private Network › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

private_network_id

string · required

Private Network ID. (UUID format)

Enable DHCP on a Private Network › Request Body

Enable DHCP on a Private Network › Responses

200

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)

scaleway.vpc.v2.Subnet[]

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.

POST/vpc/v2/regions/{region}/private-networks/{private_network_id}/enable-dhcp

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/vpc/v2/regions/{region}/private-networks/{private_network_id}/enable-dhcp"

Example Request Body

{}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "subnets": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "subnet": "1.2.3.4/32",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
      "region": "region"
    }
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "dhcp_enabled": true,
  "default_route_propagation_enabled": true,
  "has_object_storage_private_access": true
}

json

application/json

VPCs Subnets