Routes

Download schema

Custom routes that will be pushed to your private networks resources.

Create a Route

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/routes

Create a new custom Route.

Create a Route › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Create a Route › Request Body

description

string

Route description.

tags

string[]

Tags of the Route.

vpc_id

string

VPC the Route belongs to. (UUID format)

destination

string

Destination of the Route. (IP network)

nexthop_resource_id

string | null

ID of the nexthop resource. (UUID format)

nexthop_private_network_id

string | null

ID of the nexthop private network. (UUID format)

nexthop_vpc_connector_id

string | null

ID of the nexthop VPC Connector. (UUID format)

Create a Route › Responses

200

scaleway.vpc.v2.Route

id

string

Route ID. (UUID format)

srn

string

The SRN of the route.

description

string

Route description.

tags

string[]

Tags of the Route.

vpc_id

string

VPC the Route belongs to. (UUID format)

destination

string

Destination of the Route. (IP network)

nexthop_resource_id

string | null

ID of the nexthop resource. (UUID format)

nexthop_private_network_id

string | null

ID of the nexthop private network. (UUID format)

nexthop_vpc_connector_id

string | null

ID of the nexthop VPC connector. (UUID format)

created_at

string | null · date-time

Date the Route was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the Route was last modified. (RFC 3339 format)

is_read_only

boolean

Defines whether the route can be modified or deleted by the user.

type

scaleway.vpc.v2.RouteType · enum

Type of the Route.

Enum values:

unknown_route_type

subnet

default

custom

interlink

s2s_vpn

Default: unknown_route_type

region

string

Region of the Route.

POST/vpc/v2/regions/{region}/routes

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

Example Request Body

{
  "description": "description",
  "tags": [
    "string"
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "destination": "1.2.3.4/32",
  "nexthop_resource_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_vpc_connector_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "description": "description",
  "tags": [
    "string"
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "destination": "1.2.3.4/32",
  "nexthop_resource_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_vpc_connector_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "is_read_only": true,
  "type": "unknown_route_type",
  "region": "region"
}

json

application/json

Get a Route

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/routes/{route_id}

Retrieve details of an existing Route, specified by its Route ID.

Get a Route › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

route_id

string · required

Route ID. (UUID format)

Get a Route › Responses

200

scaleway.vpc.v2.Route

id

string

Route ID. (UUID format)

srn

string

The SRN of the route.

description

string

Route description.

tags

string[]

Tags of the Route.

vpc_id

string

VPC the Route belongs to. (UUID format)

destination

string

Destination of the Route. (IP network)

nexthop_resource_id

string | null

ID of the nexthop resource. (UUID format)

nexthop_private_network_id

string | null

ID of the nexthop private network. (UUID format)

nexthop_vpc_connector_id

string | null

ID of the nexthop VPC connector. (UUID format)

created_at

string | null · date-time

Date the Route was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the Route was last modified. (RFC 3339 format)

is_read_only

boolean

Defines whether the route can be modified or deleted by the user.

type

scaleway.vpc.v2.RouteType · enum

Type of the Route.

Enum values:

unknown_route_type

subnet

default

custom

interlink

s2s_vpn

Default: unknown_route_type

region

string

Region of the Route.

GET/vpc/v2/regions/{region}/routes/{route_id}

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

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "description": "description",
  "tags": [
    "string"
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "destination": "1.2.3.4/32",
  "nexthop_resource_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_vpc_connector_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "is_read_only": true,
  "type": "unknown_route_type",
  "region": "region"
}

json

application/json

Delete a Route

DELETE

https://api.scaleway.com

/vpc/v2/regions/{region}/routes/{route_id}

Delete a Route specified by its Route ID.

Delete a Route › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

route_id

string · required

Route ID. (UUID format)

Delete a Route › Responses

No data returned

Update Route

PATCH

https://api.scaleway.com

/vpc/v2/regions/{region}/routes/{route_id}

Update parameters of the specified Route.

Update Route › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

route_id

string · required

Route ID. (UUID format)

Update Route › Request Body

description

string | null

Route description.

tags

array | null

Tags of the Route.

destination

string | null

Destination of the Route. (IP network)

nexthop_resource_id

string | null

ID of the nexthop resource. (UUID format)

nexthop_private_network_id

string | null

ID of the nexthop private network. (UUID format)

nexthop_vpc_connector_id

string | null

ID of the nexthop VPC connector. (UUID format)

Update Route › Responses

200

scaleway.vpc.v2.Route

id

string

Route ID. (UUID format)

srn

string

The SRN of the route.

description

string

Route description.

tags

string[]

Tags of the Route.

vpc_id

string

VPC the Route belongs to. (UUID format)

destination

string

Destination of the Route. (IP network)

nexthop_resource_id

string | null

ID of the nexthop resource. (UUID format)

nexthop_private_network_id

string | null

ID of the nexthop private network. (UUID format)

nexthop_vpc_connector_id

string | null

ID of the nexthop VPC connector. (UUID format)

created_at

string | null · date-time

Date the Route was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the Route was last modified. (RFC 3339 format)

is_read_only

boolean

Defines whether the route can be modified or deleted by the user.

type

scaleway.vpc.v2.RouteType · enum

Type of the Route.

Enum values:

unknown_route_type

subnet

default

custom

interlink

s2s_vpn

Default: unknown_route_type

region

string

Region of the Route.

PATCH/vpc/v2/regions/{region}/routes/{route_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}/routes/{route_id}"

Example Request Body

{
  "description": "description",
  "tags": [],
  "destination": "1.2.3.4/32",
  "nexthop_resource_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_vpc_connector_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "description": "description",
  "tags": [
    "string"
  ],
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "destination": "1.2.3.4/32",
  "nexthop_resource_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "nexthop_vpc_connector_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "is_read_only": true,
  "type": "unknown_route_type",
  "region": "region"
}

json

application/json

Subnets Network ACLs