A connection represents the physical InterLink resource. This is a physical connection of Scaleway's network equipment with that of a self-hosted user or partner located in the same datacenter. Once created, a partner's connection will then typically be shared, facilitating many logical InterLinks for different hosted users. A self-hosted user's connection is their own dedicated connection, which they can use to create one or many logical InterLinks (links) for themselves.
List dedicated connections
For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the order_by field.
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 connections 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.
statusConnection status to filter for.
bandwidth_mbpsFilter for dedicated connections with this bandwidth size.
pop_idFilter for dedicated connections present in this PoP. (UUID format)
List dedicated connections › Responses
List of connections on current page.
total_countTotal number of connections returned.
Get a dedicated connection
For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection's name, status and total bandwidth.
path Parameters
regionThe region you want to target
connection_idID of connection to get. (UUID format)
Get a dedicated connection › Responses
idUnique identifier of the dedicated connection. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
statusStatus of the dedicated connection.
nameName of the dedicated connection.
tagsList of tags associated with the dedicated connection.
pop_idID of the PoP where the dedicated connection is located. (UUID format)
bandwidth_mbpsBandwidth size of the dedicated connection.
available_link_bandwidthsSize of the links supported on this dedicated connection.
created_atCreation date of the dedicated connection. (RFC 3339 format)
updated_atLast modification date of the dedicated connection. (RFC 3339 format)
demarcation_infoDemarcation details required by the data center to set up the supporting Cross Connect. This generally includes the physical space in the facility, the cabinet or rack the connection should land in, the patch panel to go in, the port designation, and the media type.
Range in which to pick vlan for self-hosted links on this dedicated connection. Both start & end are included. Any range defined here must be itself included in the greater allowed range of vlans from 1500 to 3899 (this range is hardware dependent and can change over time, but actual range will be enforced).
regionRegion of the dedicated connection.