InterLink API

Scaleway InterLink connects your infrastructure (on-premise, in a private cloud, or in another public cloud) with your Scaleway VPC

This connection bypasses the public internet, offering more reliable, low-latency and secure connectivity compared to typical internet-based VPNs.

To simplify and streamline the processes of establishing a physical connection between our networks, we have pre-selected a set of network providers (later called Partners) with direct-connectivity in our datacenters. By choosing the datacenter location (also called PoP - Point Of Presence) where both you and the partner are present, you will re-use existing connectivity with Scaleway while still having layer 2 isolation to your VPC with guaranteed bandwidth (from 100Mbps up to 25Gbps depending on location). This Hosted Link setup is fully automated and BGP sessions can be set up in a few minutes.

Once connection is established with your VPC, Interlink allows you control BGP route propagation: you can fine tune which IPv4 or IPv6 prefixes are allowed to flow.

For more advanced use cases, we also provide Self-Hosted Links, where the whole physical connection is dedicated to one customer. The customer can then use this connection to create one or many links for themselves (logical InterLink resources).

Concepts

PoP

A Point Of Presence (also known as a "PoP", or "location"), is a datacenter location where a InterLink connection is available. They are facilitated by partners, providing the means for a customer to create an InterLink.

Link

A link is the logical InterLink resource, representing a BGP peering session. It comes in two flavors :

• Hosted Links use a pre-established physical connection between the Partner router and a Scaleway InterLink switch. Create a Hosted Link by selecting a Partner already present in the PoP where you want connectivity.
• Self-Hosted Links require a Dedicated Connection between a customer router and a Scaleway Interlink switch. The whole bandwidth of the physical connection can then be used by this single customer. They can create one or many Self-Hosted Links using this dedicated connection.

Partner

A partner is a third-party service provider who facilitates a connection between the customer's infrastructure and their Scaleway VPC, allowing customers to create hosted InterLinks.

If you are a Network Service Provider and want to provide connectivity services through Scaleway's InterLink, please contact usOpen in new context.

Dedicated Connection

A dedicated connection represents the physical connection between the network equipment of a customer and that of Scaleway, where both are located in the same datacenter. Establishing a dedicated connection requires manual intervention and approval (through Letter Of Authorization) on both sides. Please contact your sales representative to purchase a dedicated connection. In the future, we will provide an automated workflow for this process.

Refer to our dedicated concepts pageOpen in new context to find definitions of all InterLink-related terminology.

Quickstart

1. Configure your environment variables.

   Note

   This is an optional step that seeks to simplify your usage of the InterLink API.

   Code
   export SCW_SECRET_KEY="<API secret key>"
   export SCW_DEFAULT_REGION="<Scaleway default region>"
   export SCW_PROJECT_ID="<Scaleway Project ID>"
   export SCW_PARTNER_ID="<Scaleway Partner ID>"
   export SCW_POP_ID="<Scaleway PoP ID>"

2. Create a Link: run the following command to create a Link. You can customize the details in the payload to your needs, using the table below to help.

   Just after creation, links have a status of Configuring while we set up infrastructure on the Scaleway side. A few moments later, the status lands on Requested and will require partner approval and configuration before being Active. See our dedicated documentationOpen in new context for full information on the provisioning process, including steps you as the user need to take to complete provisioning.

   Code
   curl -X POST \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     "https://api.scaleway.com/interlink/v1beta1/regions/$SCW_DEFAULT_REGION/links" \
     -d '{
       "project_id":"'"$SCW_PROJECT_ID"'",
       "partner_id":"'"$SCW_PARTNER_ID"'",
       "pop_id":"'"$SCW_POP_ID"'",
       "bandwidth_mbps": "100",
       "name": "My Hosted Link",
       "tags": ["test", "another tag"]
     }'

   Parameter	Description	Valid values OR Example
   project_id	ID of project	any valid project UUID
   partner_id	ID of Partner	any valid partner UUID
   pop_id	ID of PoP	any valid pop UUID
   bandwidth_mbps	Bandwidth in Mbps	50 to 25000 depending on capacity
   name	Name for Link	desired name for link
   tags	Tags for Link	a list of tags

3. Get a list of your Links: run the following command to get a list of all the links in your account, with their details:

   Code
   curl -X GET \
     -H "Content-Type: application/json" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     "https://api.scaleway.com/interlink/v1beta1/regions/$SCW_DEFAULT_REGION/links" \

4. Configure your Link: When your link has been provisioned and has active status, you must attach it to a VPC, create and attach a routing policy, and enable route propagation. Only when these steps are completed can traffic flow across your InterLink.

   Refer to the documentationOpen in new context for help with these steps if necessary.

5. Delete your Link: run the following command to delete a link. Ensure that you replace {link-id} in the URL with the ID of the link you want to delete.

   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.

   Code
   curl -X DELETE \
     -H "Content-Type: application/json" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     "https://api.scaleway.com/interlink/v1beta1/regions/$SCW_DEFAULT_REGION/links/{link-id}"