VPCs

Download schema

A Virtual Private Cloud (VPC) allows you to group your regional Private Networks together. Note that a Private Network can be a part of only one VPC.

List VPCs

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/vpcs

List existing VPCs in the specified region.

List VPCs › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List VPCs › query Parameters

order_by

scaleway.vpc.v2.ListVPCsRequest.OrderBy · enum

Sort order of the returned VPCs.

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 VPCs to return per page.

name

string

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

tags

string[]

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

organization_id

string

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

project_id

string

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

is_default

boolean

Defines whether to filter only for VPCs which are the default one for their Project.

routing_enabled

boolean

Defines whether to filter only for VPCs which route traffic between their Private Networks.

object_storage_private_access_enabled

boolean

Defines whether to filter only for VPCs with Object Storage private access enabled.

List VPCs › Responses

200

scaleway.vpc.v2.ListVPCsResponse

scaleway.vpc.v2.VPC[]

total_count

integer · uint32

GET/vpc/v2/regions/{region}/vpcs

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

Example Responses

{
  "vpcs": [
    {
      "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"
      ],
      "is_default": true,
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "private_network_count": 0,
      "routing_enabled": true,
      "custom_routes_propagation_enabled": true,
      "transitivity_enabled": true,
      "object_storage_private_access_enabled": true
    }
  ],
  "total_count": 0
}

json

application/json

Create a VPC

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/vpcs

Create a new VPC in the specified region.

Create a VPC › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Create a VPC › Request Body

name

string · required

Name for the VPC.

project_id

string · required

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

tags

string[]

Tags for the VPC.

enable_routing

boolean

Enable routing between Private Networks in the VPC.

enable_transitivity

boolean

Enable packets from peered VPCs to transit through this VPC.

Create a VPC › Responses

200

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.

POST/vpc/v2/regions/{region}/vpcs

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

Example Request Body

{
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "tags": [
    "string"
  ],
  "enable_routing": true,
  "enable_transitivity": 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"
  ],
  "is_default": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_count": 0,
  "routing_enabled": true,
  "custom_routes_propagation_enabled": true,
  "transitivity_enabled": true,
  "object_storage_private_access_enabled": true
}

json

application/json

Get a VPC

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/vpcs/{vpc_id}

Retrieve details of an existing VPC, specified by its VPC ID.

Get a VPC › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

VPC ID. (UUID format)

Get a VPC › Responses

200

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.

Delete a VPC

DELETE

https://api.scaleway.com

/vpc/v2/regions/{region}/vpcs/{vpc_id}

Delete a VPC specified by its VPC ID.

Delete a VPC › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

VPC ID. (UUID format)

Delete a VPC › Responses

No data returned

Update VPC

PATCH

https://api.scaleway.com

/vpc/v2/regions/{region}/vpcs/{vpc_id}

Update parameters including name and tags of the specified VPC.

Update VPC › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

VPC ID. (UUID format)

Update VPC › Request Body

name

string | null

Name for the VPC.

tags

array | null

Tags for the VPC.

Update VPC › Responses

200

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.

PATCH/vpc/v2/regions/{region}/vpcs/{vpc_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}/vpcs/{vpc_id}"

Example Request Body

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

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"
  ],
  "is_default": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_count": 0,
  "routing_enabled": true,
  "custom_routes_propagation_enabled": true,
  "transitivity_enabled": true,
  "object_storage_private_access_enabled": true
}

json

application/json

Enable routing on a VPC

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/vpcs/{vpc_id}/enable-routing

Enable routing on an existing VPC. Note that you will not be able to deactivate it afterwards.

Enable routing on a VPC › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

VPC ID. (UUID format)

Enable routing on a VPC › Request Body

Enable routing on a VPC › Responses

200

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.

POST/vpc/v2/regions/{region}/vpcs/{vpc_id}/enable-routing

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

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"
  ],
  "is_default": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_count": 0,
  "routing_enabled": true,
  "custom_routes_propagation_enabled": true,
  "transitivity_enabled": true,
  "object_storage_private_access_enabled": true
}

json

application/json

Private Networks