VPN Gateways

Download schema

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_by

string · enum

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.

statuses

scaleway.s2s_vpn.v1alpha1.VpnGateway.Status[]

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

scaleway.s2s_vpn.v1alpha1.ListVpnGatewaysResponse

scaleway.s2s_vpn.v1alpha1.VpnGateway[]

List of VPN gateways on the current page.

total_count

integer · uint64

Total number of VPN gateways.

GET/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways"

Example Responses

{
  "gateways": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "tags": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown_status",
      "gateway_type": "gateway_type",
      "public_config": {
        "ipam_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
        "ipam_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_config": {},
      "ipam_private_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
      "ipam_private_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d",
      "asn": 0,
      "connection_ids": [
        "string"
      ],
      "zone": "zone",
      "region": "region"
    }
  ],
  "total_count": 0
}

json

application/json

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.

object

ipam_private_ipv4_id

string

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

ipam_private_ipv6_id

string

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

zone

string

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

scaleway.s2s_vpn.v1alpha1.VpnGateway

id

string

Unique identifier of the VPN gateway. (UUID format)

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 · date-time

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

updated_at

string · date-time

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

status

string · 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.

object

Public endpoint configuration of the VPN gateway.

private_network_id

string

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

private_config

object

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.

POST/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "gateway_type": "string",
    "name": "string",
    "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d"
  }' \
  "https://api.scaleway.com/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "gateway_type": "gateway_type",
  "public_config": {
    "ipam_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
    "ipam_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "public_tunnel_config": {
    "single_ipv4_tunnel": {
      "ipam_id": "6170692e-7363-616c-6577-61792e636f6d"
    },
    "single_ipv6_tunnel": {
      "ipam_id": "6170692e-7363-616c-6577-61792e636f6d"
    },
    "dual_ipv4v6_tunnel": {
      "ipam_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
      "ipam_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d"
    }
  },
  "ipam_private_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
  "ipam_private_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d",
  "zone": "zone"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "gateway_type": "gateway_type",
  "public_config": {
    "ipam_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
    "ipam_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_config": {},
  "ipam_private_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
  "ipam_private_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d",
  "asn": 0,
  "connection_ids": [
    "string"
  ],
  "zone": "zone",
  "region": "region"
}

json

application/json

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

scaleway.s2s_vpn.v1alpha1.VpnGateway

id

string

Unique identifier of the VPN gateway. (UUID format)

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 · date-time

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

updated_at

string · date-time

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

status

string · 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.

object

Public endpoint configuration of the VPN gateway.

private_network_id

string

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

private_config

object

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/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways/{gateway_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways/{gateway_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "gateway_type": "gateway_type",
  "public_config": {
    "ipam_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
    "ipam_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_config": {},
  "ipam_private_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
  "ipam_private_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d",
  "asn": 0,
  "connection_ids": [
    "string"
  ],
  "zone": "zone",
  "region": "region"
}

json

application/json

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

scaleway.s2s_vpn.v1alpha1.VpnGateway

id

string

Unique identifier of the VPN gateway. (UUID format)

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 · date-time

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

updated_at

string · date-time

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

status

string · 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.

object

Public endpoint configuration of the VPN gateway.

private_network_id

string

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

private_config

object

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/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways/{gateway_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways/{gateway_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "gateway_type": "gateway_type",
  "public_config": {
    "ipam_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
    "ipam_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_config": {},
  "ipam_private_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
  "ipam_private_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d",
  "asn": 0,
  "connection_ids": [
    "string"
  ],
  "zone": "zone",
  "region": "region"
}

json

application/json

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

Name of the VPN gateway.

tags

string[]

List of tags to apply to the VPN Gateway.

Update a VPN gateway › Responses

200

scaleway.s2s_vpn.v1alpha1.VpnGateway

id

string

Unique identifier of the VPN gateway. (UUID format)

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 · date-time

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

updated_at

string · date-time

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

status

string · 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.

object

Public endpoint configuration of the VPN gateway.

private_network_id

string

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

private_config

object

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.

PATCH/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways/{gateway_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/s2s-vpn/v1alpha1/regions/{region}/vpn-gateways/{gateway_id}"

Example Request Body

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

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_status",
  "gateway_type": "gateway_type",
  "public_config": {
    "ipam_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
    "ipam_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_config": {},
  "ipam_private_ipv4_id": "6170692e-7363-616c-6577-61792e636f6d",
  "ipam_private_ipv6_id": "6170692e-7363-616c-6577-61792e636f6d",
  "asn": 0,
  "connection_ids": [
    "string"
  ],
  "zone": "zone",
  "region": "region"
}

json

application/json

VPN Gateway Types

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_by

string · enum

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.

statuses

scaleway.s2s_vpn.v1alpha1.VpnGateway.Status[]

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

scaleway.s2s_vpn.v1alpha1.ListVpnGatewaysResponse

scaleway.s2s_vpn.v1alpha1.VpnGateway[]

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.

object

ipam_private_ipv4_id

string

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

ipam_private_ipv6_id

string

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

zone

string

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

scaleway.s2s_vpn.v1alpha1.VpnGateway

id

string

Unique identifier of the VPN gateway. (UUID format)

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 · date-time

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

updated_at

string · date-time

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

status

string · 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.

object

Public endpoint configuration of the VPN gateway.

private_network_id

string

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

private_config

object

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

scaleway.s2s_vpn.v1alpha1.VpnGateway

id

string

Unique identifier of the VPN gateway. (UUID format)

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 · date-time

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

updated_at

string · date-time

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

status

string · 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.

object

Public endpoint configuration of the VPN gateway.

private_network_id

string

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

private_config

object

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

scaleway.s2s_vpn.v1alpha1.VpnGateway

id

string

Unique identifier of the VPN gateway. (UUID format)

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 · date-time

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

updated_at

string · date-time

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

status

string · 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.

object

Public endpoint configuration of the VPN gateway.

private_network_id

string

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

private_config

object

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

Name of the VPN gateway.

tags

string[]

List of tags to apply to the VPN Gateway.

Update a VPN gateway › Responses

200

scaleway.s2s_vpn.v1alpha1.VpnGateway

id

string

Unique identifier of the VPN gateway. (UUID format)

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 · date-time

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

updated_at

string · date-time

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

status

string · 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.

object

Public endpoint configuration of the VPN gateway.

private_network_id

string

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

private_config

object

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.