Class API

constructor

• new API(client: Client): Interlink.v1beta1.API

• Parameters

  • client: Client

  Returns Interlink.v1beta1.API

Static ReadonlyLOCALITIES

attachRoutingPolicy

• attachRoutingPolicy(
      request: Readonly<AttachRoutingPolicyRequest>,
  ): Promise<Interlink.v1beta1.Link>

• Attach a routing policy. Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow.

  Parameters

  • request: Readonly<AttachRoutingPolicyRequest>

    The request AttachRoutingPolicyRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

attachVpc

• attachVpc(request: Readonly<AttachVpcRequest>): Promise<Interlink.v1beta1.Link>

• Attach a VPC. Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure.

  Parameters

  • request: Readonly<AttachVpcRequest>

    The request AttachVpcRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

createLink

• createLink(
      request: Readonly<Interlink.v1beta1.CreateLinkRequest>,
  ): Promise<Interlink.v1beta1.Link>

• Create a link. Create a link (InterLink connection) in a given PoP, specifying its various configuration details. For the moment only hosted links (faciliated by partners) are available, though in the future dedicated and shared links will also be possible.

  Parameters

  • request: Readonly<Interlink.v1beta1.CreateLinkRequest>

    The request CreateLinkRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

createRoutingPolicy

• createRoutingPolicy(
      request: Readonly<Interlink.v1beta1.CreateRoutingPolicyRequest>,
  ): Promise<Interlink.v1beta1.RoutingPolicy>

• Create a routing policy. Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the peer, and the outgoing routes to announce to the peer.

  Parameters

  • request: Readonly<Interlink.v1beta1.CreateRoutingPolicyRequest>

    The request CreateRoutingPolicyRequest

  Returns Promise<Interlink.v1beta1.RoutingPolicy>

  A Promise of RoutingPolicy

deleteLink

• deleteLink(
      request: Readonly<DeleteLinkRequest>,
  ): Promise<Interlink.v1beta1.Link>

• Delete a link. Delete an existing link, specified by its link ID. 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.

  Parameters

  • request: Readonly<DeleteLinkRequest>

    The request DeleteLinkRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

deleteRoutingPolicy

• deleteRoutingPolicy(
      request: Readonly<DeleteRoutingPolicyRequest>,
  ): Promise<void>

• Delete a routing policy. Delete an existing routing policy, specified by its routing policy ID.

  Parameters

  • request: Readonly<DeleteRoutingPolicyRequest>

    The request DeleteRoutingPolicyRequest

  Returns Promise<void>

detachRoutingPolicy

• detachRoutingPolicy(
      request: Readonly<DetachRoutingPolicyRequest>,
  ): Promise<Interlink.v1beta1.Link>

• Detach a routing policy. Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default.

  Parameters

  • request: Readonly<DetachRoutingPolicyRequest>

    The request DetachRoutingPolicyRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

detachVpc

• detachVpc(request: Readonly<DetachVpcRequest>): Promise<Interlink.v1beta1.Link>

• Detach a VPC. Detach a VPC from an existing link.

  Parameters

  • request: Readonly<DetachVpcRequest>

    The request DetachVpcRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

disableRoutePropagation

• disableRoutePropagation(
      request: Readonly<DisableRoutePropagationRequest>,
  ): Promise<Interlink.v1beta1.Link>

• Disable route propagation. Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled.

  Parameters

  • request: Readonly<DisableRoutePropagationRequest>

    The request DisableRoutePropagationRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

enableRoutePropagation

• enableRoutePropagation(
      request: Readonly<EnableRoutePropagationRequest>,
  ): Promise<Interlink.v1beta1.Link>

• Enable route propagation. Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.

  Parameters

  • request: Readonly<EnableRoutePropagationRequest>

    The request EnableRoutePropagationRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

getLink

• getLink(request: Readonly<GetLinkRequest>): Promise<Interlink.v1beta1.Link>

• Get a link. Get a link (InterLink connection) for the given link ID. The response object includes information about the link's various configuration details.

  Parameters

  • request: Readonly<GetLinkRequest>

    The request GetLinkRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

getPartner

• getPartner(
      request: Readonly<GetPartnerRequest>,
  ): Promise<Interlink.v1beta1.Partner>

• Get a partner. Get a partner for the given partner IP. The response object includes information such as the partner's name, email address and portal URL.

  Parameters

  • request: Readonly<GetPartnerRequest>

    The request GetPartnerRequest

  Returns Promise<Interlink.v1beta1.Partner>

  A Promise of Partner

getPop

• getPop(request: Readonly<GetPopRequest>): Promise<Interlink.v1beta1.Pop>

• Get a PoP. Get a PoP for the given PoP ID. The response object includes the PoP's name and information about its physical location.

  Parameters

  • request: Readonly<GetPopRequest>

    The request GetPopRequest

  Returns Promise<Interlink.v1beta1.Pop>

  A Promise of Pop

getRoutingPolicy

• getRoutingPolicy(
      request: Readonly<GetRoutingPolicyRequest>,
  ): Promise<Interlink.v1beta1.RoutingPolicy>

• Get routing policy. Get a routing policy for the given routing policy ID. The response object gives information including the policy's name, tags and prefix filters.

  Parameters

  • request: Readonly<GetRoutingPolicyRequest>

    The request GetRoutingPolicyRequest

  Returns Promise<Interlink.v1beta1.RoutingPolicy>

  A Promise of RoutingPolicy

listLinks

• listLinks(
      request?: Readonly<Interlink.v1beta1.ListLinksRequest>,
  ): Promise<ListLinksResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Interlink.v1beta1.Link[],
          void,
          void,
      >;
      all: () => Promise<Interlink.v1beta1.Link[]>;
  }

• List links. List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status.

  Parameters

  • request: Readonly<Interlink.v1beta1.ListLinksRequest> = {}

    The request ListLinksRequest

  Returns Promise<ListLinksResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Interlink.v1beta1.Link[],
          void,
          void,
      >;
      all: () => Promise<Interlink.v1beta1.Link[]>;
  }

  A Promise of ListLinksResponse

listPartners

• listPartners(
      request?: Readonly<Interlink.v1beta1.ListPartnersRequest>,
  ): Promise<ListPartnersResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Interlink.v1beta1.Partner[],
          void,
          void,
      >;
      all: () => Promise<Interlink.v1beta1.Partner[]>;
  }

• List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<Interlink.v1beta1.ListPartnersRequest> = {}

    The request ListPartnersRequest

  Returns Promise<ListPartnersResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Interlink.v1beta1.Partner[],
          void,
          void,
      >;
      all: () => Promise<Interlink.v1beta1.Partner[]>;
  }

  A Promise of ListPartnersResponse

listPops

• listPops(
      request?: Readonly<Interlink.v1beta1.ListPopsRequest>,
  ): Promise<ListPopsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Interlink.v1beta1.Pop[],
          void,
          void,
      >;
      all: () => Promise<Interlink.v1beta1.Pop[]>;
  }

• List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name.

  Parameters

  • request: Readonly<Interlink.v1beta1.ListPopsRequest> = {}

    The request ListPopsRequest

  Returns Promise<ListPopsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Interlink.v1beta1.Pop[],
          void,
          void,
      >;
      all: () => Promise<Interlink.v1beta1.Pop[]>;
  }

  A Promise of ListPopsResponse

listRoutingPolicies

• listRoutingPolicies(
      request?: Readonly<Interlink.v1beta1.ListRoutingPoliciesRequest>,
  ): Promise<ListRoutingPoliciesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Interlink.v1beta1.RoutingPolicy[],
          void,
          void,
      >;
      all: () => Promise<Interlink.v1beta1.RoutingPolicy[]>;
  }

• List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections).

  Parameters

  • request: Readonly<Interlink.v1beta1.ListRoutingPoliciesRequest> = {}

    The request ListRoutingPoliciesRequest

  Returns Promise<ListRoutingPoliciesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Interlink.v1beta1.RoutingPolicy[],
          void,
          void,
      >;
      all: () => Promise<Interlink.v1beta1.RoutingPolicy[]>;
  }

  A Promise of ListRoutingPoliciesResponse

updateLink

• updateLink(
      request: Readonly<Interlink.v1beta1.UpdateLinkRequest>,
  ): Promise<Interlink.v1beta1.Link>

• Update a link. Update an existing link, specified by its link ID. Only its name and tags can be updated.

  Parameters

  • request: Readonly<Interlink.v1beta1.UpdateLinkRequest>

    The request UpdateLinkRequest

  Returns Promise<Interlink.v1beta1.Link>

  A Promise of Link

updateRoutingPolicy

• updateRoutingPolicy(
      request: Readonly<Interlink.v1beta1.UpdateRoutingPolicyRequest>,
  ): Promise<Interlink.v1beta1.RoutingPolicy>

• Update a routing policy. Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated.

  Parameters

  • request: Readonly<Interlink.v1beta1.UpdateRoutingPolicyRequest>

    The request UpdateRoutingPolicyRequest

  Returns Promise<Interlink.v1beta1.RoutingPolicy>

  A Promise of RoutingPolicy