A link represents the logical InterLink resource. This is a BGP peering session established between peer router (either partners or end customer's) and a Scaleway InterLink switch. Self-hosted links are facilitated by end users' own dedicated physical connections, while hosted links are facilitated via a partner's shared physical connection.
List links
List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status.
path Parameters
regionThe region you want to target
query Parameters
order_byOrder in which to return results.
pagePage number to return.
page_sizeMaximum number of links to return per page.
project_idProject ID to filter for. (UUID format)
organization_idOrganization ID to filter for. (UUID format)
nameLink name to filter for.
tagsTags to filter for.
statusLink status to filter for.
bgp_v4_statusBGP IPv4 status to filter for.
bgp_v6_statusBGP IPv6 status to filter for.
pop_idFilter for links attached to this PoP (via connections). (UUID format)
bandwidth_mbpsFilter for link bandwidth (in Mbps).
partner_idFilter for links hosted by this partner. (UUID format)
vpc_idFilter for links attached to this VPC. (UUID format)
routing_policy_idFilter for links using this routing policy. (UUID format)
pairing_keyFilter for the link with this pairing_key.
kindFilter for hosted or self-hosted links.
connection_idFilter for links self-hosted on this connection. (UUID format)
List links › Responses
List of links on the current page.
total_countTotal number of links.
Create a link
Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (facilitated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
path Parameters
regionThe region you want to target
Create a link › Request Body
nameName of the link.
pop_idPoP (location) where the link will be created. (UUID format)
bandwidth_mbpsDesired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
project_idID of the Project to create the link in. (UUID format)
tagsList of tags to apply to the link.
connection_idIf set, creates a self-hosted link using this dedicated physical connection. As the customer, specify the ID of the physical connection you already have for this link. (UUID format)
partner_idIf set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. (UUID format)
peer_asnFor self-hosted links we need the peer AS Number to establish BGP session. If not given, a default one will be assigned.
vlanFor self-hosted links only, it is possible to choose the VLAN ID. If the VLAN is not available (ie already taken or out of range), an error is returned.
routing_policy_v4_idIf set, attaches this routing policy containing IPv4 prefixes to the Link. Hence, a BGP IPv4 session will be created. (UUID format)
routing_policy_v6_idIf set, attaches this routing policy containing IPv6 prefixes to the Link. Hence, a BGP IPv6 session will be created. (UUID format)
Create a link › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Get a link
Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link's various configuration details.
path Parameters
regionThe region you want to target
link_idID of the link to get. (UUID format)
Get a link › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Delete a link
Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted.
path Parameters
regionThe region you want to target
link_idID of the link to delete. (UUID format)
Delete a link › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Update a link
Update an existing link, specified by its link ID. Only its name and tags can be updated.
path Parameters
regionThe region you want to target
link_idID of the link to update. (UUID format)
Update a link › Request Body
nameName of the link.
tagsList of tags to apply to the link.
peer_asnFor self-hosted links, AS Number to establish BGP session.
Update a link › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Attach a routing policy
Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow.
path Parameters
regionThe region you want to target
link_idID of the link to attach a routing policy to. (UUID format)
Attach a routing policy › Request Body
routing_policy_idID of the routing policy to be attached. (UUID format)
Attach a routing policy › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Attach a VPC
Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure.
path Parameters
regionThe region you want to target
link_idID of the link to attach VPC to. (UUID format)
Attach a VPC › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Detach a routing policy
Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default.
path Parameters
regionThe region you want to target
link_idID of the link to detach a routing policy from. (UUID format)
Detach a routing policy › Request Body
routing_policy_idID of the routing policy to be detached. (UUID format)
Detach a routing policy › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Detach a VPC
Detach a VPC from an existing link.
path Parameters
regionThe region you want to target
link_idID of the link to detach the VPC from. (UUID format)
Detach a VPC › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Disable route propagation
Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled.
path Parameters
regionThe region you want to target
link_idID of the link on which to disable route propagation. (UUID format)
Disable route propagation › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Enable route propagation
Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.
path Parameters
regionThe region you want to target
link_idID of the link on which to enable route propagation. (UUID format)
Enable route propagation › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)
Set a routing policy
Replace a routing policy from an existing link. This is useful when route propagation is enabled because it changes the routing policy "in place", without blocking all routes like a attach / detach would do.
path Parameters
regionThe region you want to target
link_idID of the link to set a routing policy from. (UUID format)
Set a routing policy › Request Body
routing_policy_idID of the routing policy to be set. (UUID format)
Set a routing policy › Responses
idUnique identifier of the link. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the link.
tagsList of tags associated with the link.
pop_idID of the PoP where the link's corresponding connection is located. (UUID format)
bandwidth_mbpsRate limited bandwidth of the link.
statusStatus of the link.
bgp_v4_statusStatus of the link's BGP IPv4 session.
bgp_v6_statusStatus of the link's BGP IPv6 session.
vpc_idID of the Scaleway VPC attached to the link. (UUID format)
enable_route_propagationDefines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.
created_atCreation date of the link. (RFC 3339 format)
updated_atLast modification date of the link. (RFC 3339 format)
Partner host information.
Self-host information.
vlanVLAN of the link.
BGP configuration on Scaleway's side.
BGP configuration on peer's side (on-premises or other hosting provider).
routing_policy_v4_idID of the routing policy IPv4 attached to the link. (UUID format)
routing_policy_v6_idID of the routing policy IPv6 attached to the link. (UUID format)
regionRegion of the link.
routing_policy_idDeprecated. Use routing_policy_v4_id or routing_policy_v6_id instead. (UUID format)