Scaleway logo
Site-to-Site VPN

A VPN gateway is an IPsec peer managed by Scaleway. It can support multiple connections to customer gateways.


List VPN gateways

GET
https://api.scaleway.com
/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways

List all your VPN gateways. A number of filters are available, including Project ID, name, tags and status.

List VPN gateways › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
it-mil
nl-ams
pl-waw

List VPN gateways › query Parameters

page
​integer · int32

Page number to return.

page_size
​integer · uint32

Maximum number of VPN gateways to return per page.

Order in which to return results.

Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
type_asc
type_desc
status_asc
status_desc
Default: created_at_asc
project_id
​string

Project ID to filter for. (UUID format)

organization_id
​string

Organization ID to filter for. (UUID format)

name
​string

VPN gateway name to filter for.

tags
​string[]

Tags to filter for.

VPN gateway statuses to filter for.

Enum values:
unknown_status
configuring
failed
provisioning
active
deprovisioning
locked
gateway_types
​string[]

Filter for VPN gateways of these types.

private_network_ids
​string[]

Filter for VPN gateways attached to these private networks.

List VPN gateways › Responses

200

List of VPN gateways on the current page.

total_count
​integer · uint64

Total number of VPN gateways.


Create VPN gateway

POST
https://api.scaleway.com
/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways

Create VPN gateway › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
it-mil
nl-ams
pl-waw

Create VPN gateway › Request Body

project_id
​string · required

ID of the Project to create the VPN gateway in. (UUID format)

name
​string · required

Name of the VPN gateway.

gateway_type
​string · required

VPN gateway type (commercial offer type).

private_network_id
​string · required

ID of the Private Network to attach to the VPN gateway. (UUID format)

tags
​string[]

List of tags to apply to the VPN gateway.

​

Precisely one of public_config, public_tunnel_config can be set.

ipam_private_ipv4_id
​string | null

ID of the IPAM private IPv4 address to attach to the VPN gateway. (UUID format)

ipam_private_ipv6_id
​string | null

ID of the IPAM private IPv6 address to attach to the VPN gateway. (UUID format)

zone
​string | null

Availability Zone where the VPN gateway should be provisioned. If no zone is specified, the VPN gateway will be automatically placed.

Create VPN gateway › Responses

200
id
​string

Unique identifier of the VPN gateway. (UUID format)

srn
​string · pattern: ^srn://s2s-vpn\.[^/]…

The SRN of the VPN gateway.

project_id
​string

Project ID. (UUID format)

organization_id
​string

Organization ID. (UUID format)

name
​string

Name of the VPN gateway.

tags
​string[]

List of tags applied to the VPN gateway.

created_at
​string | null · date-time

Creation date of the VPN gateway. (RFC 3339 format)

updated_at
​string | null · date-time

Last modification date of the VPN gateway. (RFC 3339 format)

status
​scaleway.s2s_vpn.v1alpha1.VpnGateway.Status · enum

Status of the VPN gateway.

Enum values:
unknown_status
configuring
failed
provisioning
active
deprovisioning
locked
Default: unknown_status
gateway_type
​string

Gateway type of the VPN gateway.

​

Public endpoint configuration of the VPN gateway. Precisely one of public_config, private_config can be set.

​

Precisely one of public_config, private_config can be set.

private_network_id
​string

ID of the Private Network attached to the VPN gateway. (UUID format)

ipam_private_ipv4_id
​string

ID of the IPAM private IPv4 address attached to the VPN gateway. (UUID format)

ipam_private_ipv6_id
​string

ID of the IPAM private IPv6 address attached to the VPN gateway. (UUID format)

asn
​integer · uint32

Autonomous System Number (ASN) of the VPN gateway, used by Border Gateway Protocol (BGP) to exchange routing information with the customer gateway.

connection_ids
​string[]

List of connection ids of the VPN gateway.

zone
​string

Zone where the VPN gateway resource is currently provisioned.

region
​string

Region of the VPN gateway.


Get a VPN gateway

GET
https://api.scaleway.com
/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways/{gateway_id}

Get a VPN gateway for the given VPN gateway ID.

Get a VPN gateway › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
it-mil
nl-ams
pl-waw
gateway_id
​string · required

ID of the requested VPN gateway. (UUID format)

Get a VPN gateway › Responses

200
id
​string

Unique identifier of the VPN gateway. (UUID format)

srn
​string · pattern: ^srn://s2s-vpn\.[^/]…

The SRN of the VPN gateway.

project_id
​string

Project ID. (UUID format)

organization_id
​string

Organization ID. (UUID format)

name
​string

Name of the VPN gateway.

tags
​string[]

List of tags applied to the VPN gateway.

created_at
​string | null · date-time

Creation date of the VPN gateway. (RFC 3339 format)

updated_at
​string | null · date-time

Last modification date of the VPN gateway. (RFC 3339 format)

status
​scaleway.s2s_vpn.v1alpha1.VpnGateway.Status · enum

Status of the VPN gateway.

Enum values:
unknown_status
configuring
failed
provisioning
active
deprovisioning
locked
Default: unknown_status
gateway_type
​string

Gateway type of the VPN gateway.

​

Public endpoint configuration of the VPN gateway. Precisely one of public_config, private_config can be set.

​

Precisely one of public_config, private_config can be set.

private_network_id
​string

ID of the Private Network attached to the VPN gateway. (UUID format)

ipam_private_ipv4_id
​string

ID of the IPAM private IPv4 address attached to the VPN gateway. (UUID format)

ipam_private_ipv6_id
​string

ID of the IPAM private IPv6 address attached to the VPN gateway. (UUID format)

asn
​integer · uint32

Autonomous System Number (ASN) of the VPN gateway, used by Border Gateway Protocol (BGP) to exchange routing information with the customer gateway.

connection_ids
​string[]

List of connection ids of the VPN gateway.

zone
​string

Zone where the VPN gateway resource is currently provisioned.

region
​string

Region of the VPN gateway.


Update a VPN gateway

PATCH
https://api.scaleway.com
/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways/{gateway_id}

Update an existing VPN gateway, specified by its VPN gateway ID. Only its name and tags can be updated.

Update a VPN gateway › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
it-mil
nl-ams
pl-waw
gateway_id
​string · required

ID of the VPN gateway to update. (UUID format)

Update a VPN gateway › Request Body

name
​string | null

Name of the VPN gateway.

tags
​array | null

List of tags to apply to the VPN Gateway.

Update a VPN gateway › Responses

200
id
​string

Unique identifier of the VPN gateway. (UUID format)

srn
​string · pattern: ^srn://s2s-vpn\.[^/]…

The SRN of the VPN gateway.

project_id
​string

Project ID. (UUID format)

organization_id
​string

Organization ID. (UUID format)

name
​string

Name of the VPN gateway.

tags
​string[]

List of tags applied to the VPN gateway.

created_at
​string | null · date-time

Creation date of the VPN gateway. (RFC 3339 format)

updated_at
​string | null · date-time

Last modification date of the VPN gateway. (RFC 3339 format)

status
​scaleway.s2s_vpn.v1alpha1.VpnGateway.Status · enum

Status of the VPN gateway.

Enum values:
unknown_status
configuring
failed
provisioning
active
deprovisioning
locked
Default: unknown_status
gateway_type
​string

Gateway type of the VPN gateway.

​

Public endpoint configuration of the VPN gateway. Precisely one of public_config, private_config can be set.

​

Precisely one of public_config, private_config can be set.

private_network_id
​string

ID of the Private Network attached to the VPN gateway. (UUID format)

ipam_private_ipv4_id
​string

ID of the IPAM private IPv4 address attached to the VPN gateway. (UUID format)

ipam_private_ipv6_id
​string

ID of the IPAM private IPv6 address attached to the VPN gateway. (UUID format)

asn
​integer · uint32

Autonomous System Number (ASN) of the VPN gateway, used by Border Gateway Protocol (BGP) to exchange routing information with the customer gateway.

connection_ids
​string[]

List of connection ids of the VPN gateway.

zone
​string

Zone where the VPN gateway resource is currently provisioned.

region
​string

Region of the VPN gateway.


Delete a VPN gateway

DELETE
https://api.scaleway.com
/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways/{gateway_id}

Delete an existing VPN gateway, specified by its VPN gateway ID.

Delete a VPN gateway › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
it-mil
nl-ams
pl-waw
gateway_id
​string · required

ID of the VPN gateway to delete. (UUID format)

Delete a VPN gateway › Responses

200
id
​string

Unique identifier of the VPN gateway. (UUID format)

srn
​string · pattern: ^srn://s2s-vpn\.[^/]…

The SRN of the VPN gateway.

project_id
​string

Project ID. (UUID format)

organization_id
​string

Organization ID. (UUID format)

name
​string

Name of the VPN gateway.

tags
​string[]

List of tags applied to the VPN gateway.

created_at
​string | null · date-time

Creation date of the VPN gateway. (RFC 3339 format)

updated_at
​string | null · date-time

Last modification date of the VPN gateway. (RFC 3339 format)

status
​scaleway.s2s_vpn.v1alpha1.VpnGateway.Status · enum

Status of the VPN gateway.

Enum values:
unknown_status
configuring
failed
provisioning
active
deprovisioning
locked
Default: unknown_status
gateway_type
​string

Gateway type of the VPN gateway.

​

Public endpoint configuration of the VPN gateway. Precisely one of public_config, private_config can be set.

​

Precisely one of public_config, private_config can be set.

private_network_id
​string

ID of the Private Network attached to the VPN gateway. (UUID format)

ipam_private_ipv4_id
​string

ID of the IPAM private IPv4 address attached to the VPN gateway. (UUID format)

ipam_private_ipv6_id
​string

ID of the IPAM private IPv6 address attached to the VPN gateway. (UUID format)

asn
​integer · uint32

Autonomous System Number (ASN) of the VPN gateway, used by Border Gateway Protocol (BGP) to exchange routing information with the customer gateway.

connection_ids
​string[]

List of connection ids of the VPN gateway.

zone
​string

Zone where the VPN gateway resource is currently provisioned.

region
​string

Region of the VPN gateway.