VPC Connectors

Download schema

A VPC peering connector constitutes one side of a VPC peering connection. It represents an intent to peer with another VPC. Two matching, compatible VPC connectors create a VPC peering connection.

List VPC connectors

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/vpc-connectors

List existing VPC connectors in the specified region.

List VPC connectors › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List VPC connectors › query Parameters

order_by

scaleway.vpc.v2.ListVPCConnectorsRequest.OrderBy · enum

Sort order of the returned VPC connectors.

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

name

string

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

tags

string[]

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

organization_id

string

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

project_id

string

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

vpc_id

string

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

target_vpc_id

string

Target VPC ID to filter for. Only connectors belonging to this target VPC will be returned. (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

List VPC connectors › Responses

200

scaleway.vpc.v2.ListVPCConnectorsResponse

scaleway.vpc.v2.VPCConnector[]

total_count

integer · uint32

GET/vpc/v2/regions/{region}/vpc-connectors

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

Example Responses

{
  "vpc_connectors": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "name": "name",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
      "target_vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_vpc_connector_status",
      "peer_info": {
        "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
        "project_id": "6170692e-7363-616c-6577-61792e636f6d",
        "vpc_name": "vpc_name"
      },
      "region": "region",
      "tags": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z"
    }
  ],
  "total_count": 0
}

json

application/json

Create a VPC connector

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/vpc-connectors

Create a new VPC connector in the specified region.

Create a VPC connector › 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 connector › Request Body

name

string · required

Name for the VPC connector.

tags

string[]

Tags for the VPC connector.

vpc_id

string

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

target_vpc_id

string

Target VPC ID to filter for. Only connectors belonging to this target VPC will be returned. (UUID format)

Create a VPC connector › Responses

200

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

scaleway.vpc.v2.VPCConnector.PeerInfo

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)

POST/vpc/v2/regions/{region}/vpc-connectors

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

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "target_vpc_id": "6170692e-7363-616c-6577-61792e636f6d"
}

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",
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "target_vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_vpc_connector_status",
  "peer_info": {
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "vpc_name": "vpc_name"
  },
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Get a VPC connector

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/vpc-connectors/{vpc_connector_id}

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

Get a VPC connector › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_connector_id

string · required

VPC connector ID. (UUID format)

Get a VPC connector › Responses

200

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

scaleway.vpc.v2.VPCConnector.PeerInfo

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)

GET/vpc/v2/regions/{region}/vpc-connectors/{vpc_connector_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/vpc/v2/regions/{region}/vpc-connectors/{vpc_connector_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",
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "target_vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_vpc_connector_status",
  "peer_info": {
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "vpc_name": "vpc_name"
  },
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Delete a VPC connector

DELETE

https://api.scaleway.com

/vpc/v2/regions/{region}/vpc-connectors/{vpc_connector_id}

Delete a VPC connector specified by its VPC connector ID.

Delete a VPC connector › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_connector_id

string · required

VPC connector ID. (UUID format)

Delete a VPC connector › Responses

No data returned

Update VPC connector

PATCH

https://api.scaleway.com

/vpc/v2/regions/{region}/vpc-connectors/{vpc_connector_id}

Update parameters including name and tags of the specified VPC connector.

Update VPC connector › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_connector_id

string · required

VPC connector ID. (UUID format)

Update VPC connector › Request Body

name

string | null

Name for the VPC connector.

tags

array | null

Tags for the VPC connector.

Update VPC connector › Responses

200

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

scaleway.vpc.v2.VPCConnector.PeerInfo

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)

PATCH/vpc/v2/regions/{region}/vpc-connectors/{vpc_connector_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}/vpc-connectors/{vpc_connector_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",
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "target_vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_vpc_connector_status",
  "peer_info": {
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "vpc_name": "vpc_name"
  },
  "region": "region",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

List subnet overlaps

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/vpc-connectors/{vpc_connector_id}/subnet-overlaps

List subnet overlaps between the VPCs on both sides of a connector, or for a specific subnet if specified.

List subnet overlaps › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_connector_id

string · required

VPC Peering connector ID. (UUID format)

List subnet overlaps › query Parameters

order_by

scaleway.vpc.v2.ListSubnetOverlapsRequest.OrderBy · enum

Sort order of the returned Subnet overlaps.

Enum values:

subnet_asc

subnet_desc

target_subnet_asc

target_subnet_desc

Default: subnet_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Maximum number of Subnet overlaps to return per page.

List subnet overlaps › Responses

200

scaleway.vpc.v2.ListSubnetOverlapsResponse

scaleway.vpc.v2.ListSubnetOverlapsResponse.SubnetOverlap[]

total_count

integer · uint64

Network ACLs Ingress Rules