Customer Gateways

Download schema

A customer gateway represents a Scaleway client's device that communicates with a VPN gateway.

List customer gateways

GET

https://api.scaleway.com

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

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

List customer gateways › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List customer gateways › query Parameters

page

integer · int32

Page number to return.

page_size

integer · uint32

Maximum number of customer 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

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

Customer gateway name to filter for.

tags

string[]

Tags to filter for.

List customer gateways › Responses

200

scaleway.s2s_vpn.v1alpha1.ListCustomerGatewaysResponse

scaleway.s2s_vpn.v1alpha1.CustomerGateway[]

List of customer gateways on the current page.

total_count

integer · uint64

Total number of customer gateways.

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

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/s2s-vpn/v1alpha1/regions/{region}/customer-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",
      "public_ipv4": "1.2.3.4",
      "public_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "asn": 0,
      "connection_ids": [
        "string"
      ],
      "region": "region"
    }
  ],
  "total_count": 0
}

json

application/json

Create a customer gateway

POST

https://api.scaleway.com

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

Create a customer gateway › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Create a customer gateway › Request Body

project_id

string · required

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

name

string · required

Name of the customer gateway.

asn

integer · uint32 · required

AS Number of the customer gateway.

tags

string[]

List of tags to apply to the customer gateway.

ipv4_public

string

Public IPv4 address of the customer gateway. (IP network)

ipv6_public

string

Public IPv6 address of the customer gateway. (IP network)

Create a customer gateway › Responses

200

scaleway.s2s_vpn.v1alpha1.CustomerGateway

id

string

Unique identifier of the customer gateway. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the customer gateway.

tags

string[]

List of tags applied to the customer gateway.

created_at

string · date-time

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

updated_at

string · date-time

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

public_ipv4

string

Public IPv4 address of the customer gateway. (IPv4 address)

public_ipv6

string

Public IPv6 address of the customer gateway. (IPv6 address)

asn

integer · uint32

AS Number of the customer gateway.

connection_ids

string[]

List of connection ids of the customer gateway.

region

string

Region of the customer gateway.

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

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

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "ipv4_public": "1.2.3.4/32",
  "ipv6_public": "1.2.3.4/32",
  "asn": 0
}

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",
  "public_ipv4": "1.2.3.4",
  "public_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  "asn": 0,
  "connection_ids": [
    "string"
  ],
  "region": "region"
}

json

application/json

Get a customer gateway

GET

https://api.scaleway.com

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

Get a customer gateway for the given customer gateway ID.

Get a customer 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 customer gateway. (UUID format)

Get a customer gateway › Responses

200

scaleway.s2s_vpn.v1alpha1.CustomerGateway

id

string

Unique identifier of the customer gateway. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the customer gateway.

tags

string[]

List of tags applied to the customer gateway.

created_at

string · date-time

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

updated_at

string · date-time

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

public_ipv4

string

Public IPv4 address of the customer gateway. (IPv4 address)

public_ipv6

string

Public IPv6 address of the customer gateway. (IPv6 address)

asn

integer · uint32

AS Number of the customer gateway.

connection_ids

string[]

List of connection ids of the customer gateway.

region

string

Region of the customer gateway.

Delete a customer gateway

DELETE

https://api.scaleway.com

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

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

Delete a customer 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 customer gateway to delete. (UUID format)

Delete a customer gateway › Responses

No data returned

Update a customer gateway

PATCH

https://api.scaleway.com

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

Update an existing customer gateway, specified by its customer gateway ID. You can update its name, tags, public IPv4 & IPv6 address and AS Number.

Update a customer 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 customer gateway to update. (UUID format)

Update a customer gateway › Request Body

name

string

Name of the customer gateway.

tags

string[]

List of tags to apply to the customer gateway.

ipv4_public

string

Public IPv4 address of the customer gateway. (IP network)

ipv6_public

string

Public IPv6 address of the customer gateway. (IP network)

asn

integer · uint32

AS Number of the customer gateway.

Update a customer gateway › Responses

200

scaleway.s2s_vpn.v1alpha1.CustomerGateway

id

string

Unique identifier of the customer gateway. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the customer gateway.

tags

string[]

List of tags applied to the customer gateway.

created_at

string · date-time

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

updated_at

string · date-time

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

public_ipv4

string

Public IPv4 address of the customer gateway. (IPv4 address)

public_ipv6

string

Public IPv6 address of the customer gateway. (IPv6 address)

asn

integer · uint32

AS Number of the customer gateway.

connection_ids

string[]

List of connection ids of the customer gateway.

region

string

Region of the customer gateway.

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

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "ipv4_public": "1.2.3.4/32",
  "ipv6_public": "1.2.3.4/32",
  "asn": 0
}

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",
  "public_ipv4": "1.2.3.4",
  "public_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  "asn": 0,
  "connection_ids": [
    "string"
  ],
  "region": "region"
}

json

application/json

Connections Routing Policies

List customer gateways

GET

https://api.scaleway.com

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

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

List customer gateways › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List customer gateways › query Parameters

page

integer · int32

Page number to return.

page_size

integer · uint32

Maximum number of customer 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

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

Customer gateway name to filter for.

tags

string[]

Tags to filter for.

List customer gateways › Responses

200

scaleway.s2s_vpn.v1alpha1.ListCustomerGatewaysResponse

scaleway.s2s_vpn.v1alpha1.CustomerGateway[]

List of customer gateways on the current page.

total_count

integer · uint64

Total number of customer gateways.

Create a customer gateway

POST

https://api.scaleway.com

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

Create a customer gateway › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Create a customer gateway › Request Body

project_id

string · required

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

name

string · required

Name of the customer gateway.

asn

integer · uint32 · required

AS Number of the customer gateway.

tags

string[]

List of tags to apply to the customer gateway.

ipv4_public

string

Public IPv4 address of the customer gateway. (IP network)

ipv6_public

string

Public IPv6 address of the customer gateway. (IP network)

Create a customer gateway › Responses

200

scaleway.s2s_vpn.v1alpha1.CustomerGateway

id

string

Unique identifier of the customer gateway. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the customer gateway.

tags

string[]

List of tags applied to the customer gateway.

created_at

string · date-time

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

updated_at

string · date-time

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

public_ipv4

string

Public IPv4 address of the customer gateway. (IPv4 address)

public_ipv6

string

Public IPv6 address of the customer gateway. (IPv6 address)

asn

integer · uint32

AS Number of the customer gateway.

connection_ids

string[]

List of connection ids of the customer gateway.

region

string

Region of the customer gateway.

Get a customer gateway

GET

https://api.scaleway.com

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

Get a customer gateway for the given customer gateway ID.

Get a customer 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 customer gateway. (UUID format)

Get a customer gateway › Responses

200

scaleway.s2s_vpn.v1alpha1.CustomerGateway

id

string

Unique identifier of the customer gateway. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the customer gateway.

tags

string[]

List of tags applied to the customer gateway.

created_at

string · date-time

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

updated_at

string · date-time

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

public_ipv4

string

Public IPv4 address of the customer gateway. (IPv4 address)

public_ipv6

string

Public IPv6 address of the customer gateway. (IPv6 address)

asn

integer · uint32

AS Number of the customer gateway.

connection_ids

string[]

List of connection ids of the customer gateway.

region

string

Region of the customer gateway.

Delete a customer gateway

DELETE

https://api.scaleway.com

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

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

Delete a customer 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 customer gateway to delete. (UUID format)

Delete a customer gateway › Responses

No data returned

Update a customer gateway

PATCH

https://api.scaleway.com

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

Update an existing customer gateway, specified by its customer gateway ID. You can update its name, tags, public IPv4 & IPv6 address and AS Number.

Update a customer 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 customer gateway to update. (UUID format)

Update a customer gateway › Request Body

name

string

Name of the customer gateway.

tags

string[]

List of tags to apply to the customer gateway.

ipv4_public

string

Public IPv4 address of the customer gateway. (IP network)

ipv6_public

string

Public IPv6 address of the customer gateway. (IP network)

asn

integer · uint32

AS Number of the customer gateway.

Update a customer gateway › Responses

200

scaleway.s2s_vpn.v1alpha1.CustomerGateway

id

string

Unique identifier of the customer gateway. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the customer gateway.

tags

string[]

List of tags applied to the customer gateway.

created_at

string · date-time

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

updated_at

string · date-time

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

public_ipv4

string

Public IPv4 address of the customer gateway. (IPv4 address)

public_ipv6

string

Public IPv6 address of the customer gateway. (IPv6 address)

asn

integer · uint32

AS Number of the customer gateway.

connection_ids

string[]

List of connection ids of the customer gateway.

region

string

Region of the customer gateway.