Type Alias ListLinksRequest

ListLinksRequest: {
    bandwidthMbps?: number;
    bgpV4Status?: BgpStatus;
    bgpV6Status?: BgpStatus;
    name?: string;
    orderBy?: ListLinksRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    pairingKey?: string;
    partnerId?: string;
    popId?: string;
    projectId?: string;
    region?: Region;
    routingPolicyId?: string;
    status?: LinkStatus;
    tags?: string[];
    vpcId?: string;
}

Type declaration

  • OptionalbandwidthMbps?: number

    Filter for link bandwidth (in Mbps).

  • OptionalbgpV4Status?: BgpStatus

    BGP IPv4 status to filter for.

  • OptionalbgpV6Status?: BgpStatus

    BGP IPv6 status to filter for.

  • Optionalname?: string

    Link name to filter for.

  • OptionalorderBy?: ListLinksRequestOrderBy

    Order in which to return results.

  • OptionalorganizationId?: string

    Organization ID to filter for.

  • Optionalpage?: number

    Page number to return.

  • OptionalpageSize?: number

    Maximum number of links to return per page.

  • OptionalpairingKey?: string

    Filter for the link with this pairing_key.

  • OptionalpartnerId?: string

    Filter for links hosted by this partner.

  • OptionalpopId?: string

    Filter for links attached to this PoP (via ports).

  • OptionalprojectId?: string

    Project ID to filter for.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • OptionalroutingPolicyId?: string

    Filter for links using this routing policy.

  • Optionalstatus?: LinkStatus

    Link status to filter for.

  • Optionaltags?: string[]

    Tags to filter for.

  • OptionalvpcId?: string

    Filter for links attached to this VPC.

Settings