Class API

constructor

• new API(client): VPC.v2.API

• Parameters

  • client: Client

  Returns VPC.v2.API

Static ReadonlyLOCALITIES

addSubnets

• addSubnets(request): Promise<AddSubnetsResponse>

• Add subnets to a Private Network. Add new subnets to an existing Private Network.

  Parameters

  • request: Readonly<AddSubnetsRequest>

    The request AddSubnetsRequest

  Returns Promise<AddSubnetsResponse>

  A Promise of AddSubnetsResponse

createPrivateNetwork

• createPrivateNetwork(request?): Promise<VPC.v2.PrivateNetwork>

• Create a Private Network. Create a new Private Network. Once created, you can attach Scaleway resources which are in the same region.

  Parameters

  • request: Readonly<VPC.v2.CreatePrivateNetworkRequest> = {}

    The request CreatePrivateNetworkRequest

  Returns Promise<VPC.v2.PrivateNetwork>

  A Promise of PrivateNetwork

createRoute

• createRoute(request): Promise<VPC.v2.Route>

• Create a Route. Create a new custom Route.

  Parameters

  • request: Readonly<VPC.v2.CreateRouteRequest>

    The request CreateRouteRequest

  Returns Promise<VPC.v2.Route>

  A Promise of Route

createVPC

• createVPC(request): Promise<VPC>

• Create a VPC. Create a new VPC in the specified region.

  Parameters

  • request: Readonly<CreateVPCRequest>

    The request CreateVPCRequest

  Returns Promise<VPC>

  A Promise of VPC

deletePrivateNetwork

• deletePrivateNetwork(request): Promise<void>

• Delete a Private Network. Delete an existing Private Network. Note that you must first detach all resources from the network, in order to delete it.

  Parameters

  • request: Readonly<VPC.v2.DeletePrivateNetworkRequest>

    The request DeletePrivateNetworkRequest

  Returns Promise<void>

deleteRoute

• deleteRoute(request): Promise<void>

• Delete a Route. Delete a Route specified by its Route ID.

  Parameters

  • request: Readonly<VPC.v2.DeleteRouteRequest>

    The request DeleteRouteRequest

  Returns Promise<void>

deleteSubnets

• deleteSubnets(request): Promise<DeleteSubnetsResponse>

• Delete subnets from a Private Network. Delete the specified subnets from a Private Network.

  Parameters

  • request: Readonly<DeleteSubnetsRequest>

    The request DeleteSubnetsRequest

  Returns Promise<DeleteSubnetsResponse>

  A Promise of DeleteSubnetsResponse

deleteVPC

• deleteVPC(request): Promise<void>

• Delete a VPC. Delete a VPC specified by its VPC ID.

  Parameters

  • request: Readonly<DeleteVPCRequest>

    The request DeleteVPCRequest

  Returns Promise<void>

enableDHCP

• enableDHCP(request): Promise<VPC.v2.PrivateNetwork>

• Enable DHCP on a Private Network. Enable DHCP managed on an existing Private Network. Note that you will not be able to deactivate it afterwards.

  Parameters

  • request: Readonly<EnableDHCPRequest>

    The request EnableDHCPRequest

  Returns Promise<VPC.v2.PrivateNetwork>

  A Promise of PrivateNetwork

enableRouting

• enableRouting(request): Promise<VPC>

• Enable routing on a VPC. Enable routing on an existing VPC. Note that you will not be able to deactivate it afterwards.

  Parameters

  • request: Readonly<EnableRoutingRequest>

    The request EnableRoutingRequest

  Returns Promise<VPC>

  A Promise of VPC

getPrivateNetwork

• getPrivateNetwork(request): Promise<VPC.v2.PrivateNetwork>

• Get a Private Network. Retrieve information about an existing Private Network, specified by its Private Network ID. Its full details are returned in the response object.

  Parameters

  • request: Readonly<VPC.v2.GetPrivateNetworkRequest>

    The request GetPrivateNetworkRequest

  Returns Promise<VPC.v2.PrivateNetwork>

  A Promise of PrivateNetwork

getRoute

• getRoute(request): Promise<VPC.v2.Route>

• Get a Route. Retrieve details of an existing Route, specified by its Route ID.

  Parameters

  • request: Readonly<VPC.v2.GetRouteRequest>

    The request GetRouteRequest

  Returns Promise<VPC.v2.Route>

  A Promise of Route

getVPC

• getVPC(request): Promise<VPC>

• Get a VPC. Retrieve details of an existing VPC, specified by its VPC ID.

  Parameters

  • request: Readonly<GetVPCRequest>

    The request GetVPCRequest

  Returns Promise<VPC>

  A Promise of VPC

listPrivateNetworks

• listPrivateNetworks(request?): Promise<VPC.v2.ListPrivateNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<VPC.v2.PrivateNetwork[], void, void>);
      all: (() => Promise<VPC.v2.PrivateNetwork[]>);
  }

• List Private Networks. List existing Private Networks in the specified region. By default, the Private Networks returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<VPC.v2.ListPrivateNetworksRequest> = {}

    The request ListPrivateNetworksRequest

  Returns Promise<VPC.v2.ListPrivateNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<VPC.v2.PrivateNetwork[], void, void>);
      all: (() => Promise<VPC.v2.PrivateNetwork[]>);
  }

  A Promise of ListPrivateNetworksResponse

listSubnets

• listSubnets(request?): Promise<ListSubnetsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Subnet[], void, void>);
      all: (() => Promise<Subnet[]>);
  }

• List subnets. List any Private Network's subnets. See ListPrivateNetworks to list a specific Private Network's subnets.

  Parameters

  • request: Readonly<ListSubnetsRequest> = {}

    The request ListSubnetsRequest

  Returns Promise<ListSubnetsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Subnet[], void, void>);
      all: (() => Promise<Subnet[]>);
  }

  A Promise of ListSubnetsResponse

listVPCs

• listVPCs(request?): Promise<ListVPCsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<VPC[], void, void>);
      all: (() => Promise<VPC[]>);
  }

• List VPCs. List existing VPCs in the specified region.

  Parameters

  • request: Readonly<ListVPCsRequest> = {}

    The request ListVPCsRequest

  Returns Promise<ListVPCsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<VPC[], void, void>);
      all: (() => Promise<VPC[]>);
  }

  A Promise of ListVPCsResponse

migrateZonalPrivateNetworks

• migrateZonalPrivateNetworks(request?): Promise<void>

• Migrate Private Networks from zoned to regional. Transform multiple existing zoned Private Networks (scoped to a single Availability Zone) into regional Private Networks, scoped to an entire region. You can transform one or many Private Networks (specified by their Private Network IDs) within a single Scaleway Organization or Project, with the same call.

  Parameters

  • request: Readonly<MigrateZonalPrivateNetworksRequest> = {}

    The request MigrateZonalPrivateNetworksRequest

  Returns Promise<void>

setSubnets

• setSubnets(request): Promise<SetSubnetsResponse>

• Set a Private Network's subnets. Set subnets for an existing Private Network. Note that the method is PUT and not PATCH. Any existing subnets will be removed in favor of the new specified set of subnets.

  Parameters

  • request: Readonly<SetSubnetsRequest>

    The request SetSubnetsRequest

  Returns Promise<SetSubnetsResponse>

  A Promise of SetSubnetsResponse

updatePrivateNetwork

• updatePrivateNetwork(request): Promise<VPC.v2.PrivateNetwork>

• Update Private Network. Update parameters (such as name or tags) of an existing Private Network, specified by its Private Network ID.

  Parameters

  • request: Readonly<VPC.v2.UpdatePrivateNetworkRequest>

    The request UpdatePrivateNetworkRequest

  Returns Promise<VPC.v2.PrivateNetwork>

  A Promise of PrivateNetwork

updateRoute

• updateRoute(request): Promise<VPC.v2.Route>

• Update Route. Update parameters of the specified Route.

  Parameters

  • request: Readonly<VPC.v2.UpdateRouteRequest>

    The request UpdateRouteRequest

  Returns Promise<VPC.v2.Route>

  A Promise of Route

updateVPC

• updateVPC(request): Promise<VPC>

• Update VPC. Update parameters including name and tags of the specified VPC.

  Parameters

  • request: Readonly<UpdateVPCRequest>

    The request UpdateVPCRequest

  Returns Promise<VPC>

  A Promise of VPC