Routing Policies

Download schema

By default, all routes across the Site-to-Site VPN (between VPN gateway and customer gateway) are blocked. Routing policies allow you to set filters to define the IP prefixes to allow.

List routing policies

GET

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies

List all routing policies in a given region. A routing policy can be attached to one or multiple connections (S2S VPN connections).

List routing policies › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List routing policies › query Parameters

page

integer · int32

Page number to return.

page_size

integer · uint32

Maximum number of routing policies 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

Routing policy name to filter for.

tags

string[]

Tags to filter for.

ipv6

boolean

Filter for the routing policies based on IP prefixes version.

List routing policies › Responses

200

scaleway.s2s_vpn.v1alpha1.ListRoutingPoliciesResponse

scaleway.s2s_vpn.v1alpha1.RoutingPolicy[]

total_count

integer · uint64

GET/s2s-vpn/v1alpha1/regions/{region}/routing-policies

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

Example Responses

{
  "routing_policies": [
    {
      "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",
      "is_ipv6": true,
      "prefix_filter_in": [
        "1.2.3.4/32"
      ],
      "prefix_filter_out": [
        "1.2.3.4/32"
      ],
      "region": "region"
    }
  ],
  "total_count": 0
}

json

application/json

Create a routing policy

POST

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies

Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the customer gateway, and the outgoing routes to announce to the customer gateway.

Create a routing policy › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Create a routing policy › Request Body

project_id

string · required

ID of the Project to create the routing policy in. (UUID format)

name

string · required

Name of the routing policy.

tags

string[]

List of tags to apply to the routing policy.

is_ipv6

boolean

IP prefixes version of the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept). (IP network)

prefix_filter_out

string[]

IP prefix filters to advertise to the peer (ranges of routes to advertise). (IP network)

Create a routing policy › Responses

200

scaleway.s2s_vpn.v1alpha1.RoutingPolicy

id

string

Unique identifier of the routing policy. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the routing policy.

tags

string[]

List of tags associated with the routing policy.

created_at

string · date-time

Creation date of the routing policy. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the routing policy. (RFC 3339 format)

is_ipv6

boolean

IP prefixes version of the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept). (IP network)

prefix_filter_out

string[]

IP prefix filters to advertise to the peer (ranges of routes to advertise). (IP network)

region

string

Region of the routing policy.

POST/s2s-vpn/v1alpha1/regions/{region}/routing-policies

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

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "is_ipv6": true,
  "prefix_filter_in": [
    "1.2.3.4/32"
  ],
  "prefix_filter_out": [
    "1.2.3.4/32"
  ]
}

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",
  "is_ipv6": true,
  "prefix_filter_in": [
    "1.2.3.4/32"
  ],
  "prefix_filter_out": [
    "1.2.3.4/32"
  ],
  "region": "region"
}

json

application/json

Get routing policy

GET

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies/{routing_policy_id}

Get a routing policy for the given routing policy ID. The response object gives information including the policy's name, tags and prefix filters.

Get routing policy › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

routing_policy_id

string · required

ID of the routing policy to get. (UUID format)

Get routing policy › Responses

200

scaleway.s2s_vpn.v1alpha1.RoutingPolicy

id

string

Unique identifier of the routing policy. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the routing policy.

tags

string[]

List of tags associated with the routing policy.

created_at

string · date-time

Creation date of the routing policy. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the routing policy. (RFC 3339 format)

is_ipv6

boolean

IP prefixes version of the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept). (IP network)

prefix_filter_out

string[]

IP prefix filters to advertise to the peer (ranges of routes to advertise). (IP network)

region

string

Region of the routing policy.

Delete a routing policy

DELETE

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies/{routing_policy_id}

Delete an existing routing policy, specified by its routing policy ID.

Delete a routing policy › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

routing_policy_id

string · required

ID of the routing policy to delete. (UUID format)

Delete a routing policy › Responses

No data returned

Update a routing policy

PATCH

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies/{routing_policy_id}

Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated.

Update a routing policy › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

routing_policy_id

string · required

ID of the routing policy to update. (UUID format)

Update a routing policy › Request Body

name

string

Name of the routing policy.

tags

string[]

List of tags to apply to the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept).

prefix_filter_out

string[]

IP prefix filters for routes to advertise to the peer (ranges of routes to advertise).

Update a routing policy › Responses

200

scaleway.s2s_vpn.v1alpha1.RoutingPolicy

id

string

Unique identifier of the routing policy. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the routing policy.

tags

string[]

List of tags associated with the routing policy.

created_at

string · date-time

Creation date of the routing policy. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the routing policy. (RFC 3339 format)

is_ipv6

boolean

IP prefixes version of the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept). (IP network)

prefix_filter_out

string[]

IP prefix filters to advertise to the peer (ranges of routes to advertise). (IP network)

region

string

Region of the routing policy.

PATCH/s2s-vpn/v1alpha1/regions/{region}/routing-policies/{routing_policy_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}/routing-policies/{routing_policy_id}"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "prefix_filter_in": [
    "string"
  ],
  "prefix_filter_out": [
    "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",
  "is_ipv6": true,
  "prefix_filter_in": [
    "1.2.3.4/32"
  ],
  "prefix_filter_out": [
    "1.2.3.4/32"
  ],
  "region": "region"
}

json

application/json

Customer Gateways

List routing policies

GET

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies

List all routing policies in a given region. A routing policy can be attached to one or multiple connections (S2S VPN connections).

List routing policies › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List routing policies › query Parameters

page

integer · int32

Page number to return.

page_size

integer · uint32

Maximum number of routing policies 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

Routing policy name to filter for.

tags

string[]

Tags to filter for.

ipv6

boolean

Filter for the routing policies based on IP prefixes version.

List routing policies › Responses

200

scaleway.s2s_vpn.v1alpha1.ListRoutingPoliciesResponse

scaleway.s2s_vpn.v1alpha1.RoutingPolicy[]

total_count

integer · uint64

Create a routing policy

POST

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies

Create a routing policy › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Create a routing policy › Request Body

project_id

string · required

ID of the Project to create the routing policy in. (UUID format)

name

string · required

Name of the routing policy.

tags

string[]

List of tags to apply to the routing policy.

is_ipv6

boolean

IP prefixes version of the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept). (IP network)

prefix_filter_out

string[]

IP prefix filters to advertise to the peer (ranges of routes to advertise). (IP network)

Create a routing policy › Responses

200

scaleway.s2s_vpn.v1alpha1.RoutingPolicy

id

string

Unique identifier of the routing policy. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the routing policy.

tags

string[]

List of tags associated with the routing policy.

created_at

string · date-time

Creation date of the routing policy. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the routing policy. (RFC 3339 format)

is_ipv6

boolean

IP prefixes version of the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept). (IP network)

prefix_filter_out

string[]

IP prefix filters to advertise to the peer (ranges of routes to advertise). (IP network)

region

string

Region of the routing policy.

Get routing policy

GET

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies/{routing_policy_id}

Get a routing policy for the given routing policy ID. The response object gives information including the policy's name, tags and prefix filters.

Get routing policy › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

routing_policy_id

string · required

ID of the routing policy to get. (UUID format)

Get routing policy › Responses

200

scaleway.s2s_vpn.v1alpha1.RoutingPolicy

id

string

Unique identifier of the routing policy. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the routing policy.

tags

string[]

List of tags associated with the routing policy.

created_at

string · date-time

Creation date of the routing policy. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the routing policy. (RFC 3339 format)

is_ipv6

boolean

IP prefixes version of the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept). (IP network)

prefix_filter_out

string[]

IP prefix filters to advertise to the peer (ranges of routes to advertise). (IP network)

region

string

Region of the routing policy.

Delete a routing policy

DELETE

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies/{routing_policy_id}

Delete an existing routing policy, specified by its routing policy ID.

Delete a routing policy › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

routing_policy_id

string · required

ID of the routing policy to delete. (UUID format)

Delete a routing policy › Responses

No data returned

Update a routing policy

PATCH

https://api.scaleway.com

/s2s-vpn/v1alpha1/regions/{region}/routing-policies/{routing_policy_id}

Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated.

Update a routing policy › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

routing_policy_id

string · required

ID of the routing policy to update. (UUID format)

Update a routing policy › Request Body

name

string

Name of the routing policy.

tags

string[]

List of tags to apply to the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept).

prefix_filter_out

string[]

IP prefix filters for routes to advertise to the peer (ranges of routes to advertise).

Update a routing policy › Responses

200

scaleway.s2s_vpn.v1alpha1.RoutingPolicy

id

string

Unique identifier of the routing policy. (UUID format)

project_id

string

Project ID. (UUID format)

organization_id

string

Organization ID. (UUID format)

name

string

Name of the routing policy.

tags

string[]

List of tags associated with the routing policy.

created_at

string · date-time

Creation date of the routing policy. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the routing policy. (RFC 3339 format)

is_ipv6

boolean

IP prefixes version of the routing policy.

prefix_filter_in

string[]

IP prefixes to accept from the peer (ranges of route announcements to accept). (IP network)

prefix_filter_out

string[]

IP prefix filters to advertise to the peer (ranges of routes to advertise). (IP network)

region

string

Region of the routing policy.