Interface Link

interface Link {
    bandwidthMbps: number;
    bgpV4Status: BgpStatus;
    bgpV6Status: BgpStatus;
    createdAt?: Date;
    disapprovedReason?: string;
    enableRoutePropagation: boolean;
    id: string;
    name: string;
    organizationId: string;
    pairingKey: string;
    partnerId?: string;
    popId: string;
    projectId: string;
    region: Region;
    routingPolicyId?: string;
    status: LinkStatus;
    tags: string[];
    updatedAt?: Date;
    vpcId?: string;
}

Properties

bandwidthMbps bgpV4Status bgpV6Status createdAt? disapprovedReason? enableRoutePropagation id name organizationId pairingKey partnerId? popId projectId region routingPolicyId? status tags updatedAt? vpcId?

Properties

bandwidthMbps

bandwidthMbps: number

Rate limited bandwidth of the link.

bgpV4Status

bgpV4Status: BgpStatus

Status of the link's BGP IPv4 session.

bgpV6Status

bgpV6Status: BgpStatus

Status of the link's BGP IPv6 session.

OptionalcreatedAt

createdAt?: Date

Creation date of the link.

OptionaldisapprovedReason

disapprovedReason?: string

Reason given by partner to explain why they did not approve the request for a hosted link.

enableRoutePropagation

enableRoutePropagation: boolean

Defines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint.

id

id: string

Unique identifier of the link.

name

name: string

Name of the link.

organizationId

organizationId: string

Organization ID.

pairingKey

pairingKey: string

Used to identify a link from a user or partner's point of view.

OptionalpartnerId

partnerId?: string

ID of the partner facilitating this link.

popId

popId: string

ID of the PoP where the link's corresponding port is located.

projectId

projectId: string

Project ID.

region

region: Region

Region of the link.

OptionalroutingPolicyId

routingPolicyId?: string

ID of the routing policy attached to the link.

status

status: LinkStatus

Status of the link.

tags

tags: string[]

List of tags associated with the link.

OptionalupdatedAt

updatedAt?: Date

Last modification date of the link.

OptionalvpcId

vpcId?: string

ID of the Scaleway VPC attached to the link.

Settings

On This Page

Properties