InterLink API

Introduction

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, in the future we will provide Dedicated Links, where the whole physical connectivity is dedicated to you. Please contact your sales representative to know more.

Concepts

PoP

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

Link

A link is an InterLink connection, representing a BGP peering session established between your on-premises router and a Scaleway InterLink switch. For now, you can only create Hosted Links by selecting a Partner already present in the PoP where you want connectivity.

Partner

A partner is a third-party service provider who facilitates the connection between the a customer's infrastructure and their Scaleway VPC, via an InterLink port.

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

Refer to our dedicated concepts page 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.

   export SCW_SECRET_KEY="<API secret key>"
   export SCW_DEFAULT_REGION="<Scaleway default region>"
   export SCW_PROJECT_ID="<Scaleway Project 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 documentation for full information on the provisioning process, including steps you as the user need to take to complete provisioning.

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"]
  }'

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:

   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 documentation 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.

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}"

Technical information

• IP routing information between your infrastructure & your VPC is propagated using BGP, so be sure to allow incoming BGP routes from the configured Scaleway peer to be installed on your side. By default, our Interlink switches blocks all routes from being propagated. You must manually attach a routing policy and enable route propagation to remove this safety net (see step 4 of the Quickstart above).

Regions

The Scaleway Interlink API is a regional API, meaning that each call must specify in its path parameters the Region for the resources concerned by the call.

The following Regions are available for Interlink:

Technical limitations

• Scaleway InterLink is currently only available as a Hosted Link in Opcore DC2 POP.

Going further

For more help using Scaleway InterLink, check out the following resources:

• Our main documentation
• The #vpc channel on our Slack Community
• Our support ticketing system.

Partners

Points Of Presence

Links

Routing Policies