Class API

constructor

• new API(client: Client): VPCGW.v2.API

• Parameters

  • client: Client

  Returns VPCGW.v2.API

Static ReadonlyLOCALITIES

addBastionAllowedIPs

• addBastionAllowedIPs(
      request: Readonly<AddBastionAllowedIPsRequest>,
  ): Promise<AddBastionAllowedIPsResponse>

• Add allowed IP range to SSH bastion. Add an IP range (in CIDR notation) to be allowed to connect to the SSH bastion.

  Parameters

  • request: Readonly<AddBastionAllowedIPsRequest>

    The request AddBastionAllowedIPsRequest

  Returns Promise<AddBastionAllowedIPsResponse>

  A Promise of AddBastionAllowedIPsResponse

createGateway

• createGateway(
      request: Readonly<VPCGW.v2.CreateGatewayRequest>,
  ): Promise<VPCGW.v2.Gateway>

• Create a Public Gateway. Create a new Public Gateway in the specified Scaleway Project, defining its name, type and other configuration details such as whether to enable SSH bastion.

  Parameters

  • request: Readonly<VPCGW.v2.CreateGatewayRequest>

    The request CreateGatewayRequest

  Returns Promise<VPCGW.v2.Gateway>

  A Promise of Gateway

createGatewayNetwork

• createGatewayNetwork(
      request: Readonly<VPCGW.v2.CreateGatewayNetworkRequest>,
  ): Promise<VPCGW.v2.GatewayNetwork>

• Attach a Public Gateway to a Private Network. Attach a specific Public Gateway to a specific Private Network (create a GatewayNetwork). You can configure parameters for the connection including whether to enable masquerade (dynamic NAT), and more.

  Parameters

  • request: Readonly<VPCGW.v2.CreateGatewayNetworkRequest>

    The request CreateGatewayNetworkRequest

  Returns Promise<VPCGW.v2.GatewayNetwork>

  A Promise of GatewayNetwork

createIP

• createIP(request?: Readonly<VPCGW.v2.CreateIPRequest>): Promise<VPCGW.v2.IP>

• Reserve an IP. Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project.

  Parameters

  • request: Readonly<VPCGW.v2.CreateIPRequest> = {}

    The request CreateIPRequest

  Returns Promise<VPCGW.v2.IP>

  A Promise of IP

createPatRule

• createPatRule(request: Readonly<CreatePatRuleRequest>): Promise<PatRule>

• Create a PAT rule. Create a new PAT rule on a specified Public Gateway, defining the protocol to use, public port to listen on, and private port / IP address to map to.

  Parameters

  • request: Readonly<CreatePatRuleRequest>

    The request CreatePatRuleRequest

  Returns Promise<PatRule>

  A Promise of PatRule

deleteBastionAllowedIPs

• deleteBastionAllowedIPs(
      request: Readonly<DeleteBastionAllowedIPsRequest>,
  ): Promise<void>

• Delete allowed IP range from SSH bastion. Delete an IP range (defined in CIDR notation) from SSH bastion, so that it is no longer allowed to connect.

  Parameters

  • request: Readonly<DeleteBastionAllowedIPsRequest>

    The request DeleteBastionAllowedIPsRequest

  Returns Promise<void>

deleteGateway

• deleteGateway(
      request: Readonly<VPCGW.v2.DeleteGatewayRequest>,
  ): Promise<VPCGW.v2.Gateway>

• Delete a Public Gateway. Delete an existing Public Gateway, specified by its gateway ID. This action is irreversible.

  Parameters

  • request: Readonly<VPCGW.v2.DeleteGatewayRequest>

    The request DeleteGatewayRequest

  Returns Promise<VPCGW.v2.Gateway>

  A Promise of Gateway

deleteGatewayNetwork

• deleteGatewayNetwork(
      request: Readonly<VPCGW.v2.DeleteGatewayNetworkRequest>,
  ): Promise<VPCGW.v2.GatewayNetwork>

• Detach a Public Gateway from a Private Network. Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id.

  Parameters

  • request: Readonly<VPCGW.v2.DeleteGatewayNetworkRequest>

    The request DeleteGatewayNetworkRequest

  Returns Promise<VPCGW.v2.GatewayNetwork>

  A Promise of GatewayNetwork

deleteIP

• deleteIP(request: Readonly<VPCGW.v2.DeleteIPRequest>): Promise<void>

• Delete an IP. Delete a flexible IP address from your account. This action is irreversible.

  Parameters

  • request: Readonly<VPCGW.v2.DeleteIPRequest>

    The request DeleteIPRequest

  Returns Promise<void>

deletePatRule

• deletePatRule(request: Readonly<DeletePatRuleRequest>): Promise<void>

• Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This action is irreversible.

  Parameters

  • request: Readonly<DeletePatRuleRequest>

    The request DeletePatRuleRequest

  Returns Promise<void>

getGateway

• getGateway(
      request: Readonly<VPCGW.v2.GetGatewayRequest>,
  ): Promise<VPCGW.v2.Gateway>

• Get a Public Gateway. Get details of a Public Gateway, specified by its gateway ID. The response object contains full details of the gateway, including its name, type, status and more.

  Parameters

  • request: Readonly<VPCGW.v2.GetGatewayRequest>

    The request GetGatewayRequest

  Returns Promise<VPCGW.v2.Gateway>

  A Promise of Gateway

getGatewayNetwork

• getGatewayNetwork(
      request: Readonly<VPCGW.v2.GetGatewayNetworkRequest>,
  ): Promise<VPCGW.v2.GatewayNetwork>

• Get a Public Gateway connection to a Private Network. Get details of a given connection between a Public Gateway and a Private Network (this connection = a GatewayNetwork), specified by its gateway_network_id. The response object contains details of the connection including the IDs of the Public Gateway and Private Network, the dates the connection was created/updated and its configuration settings.

  Parameters

  • request: Readonly<VPCGW.v2.GetGatewayNetworkRequest>

    The request GetGatewayNetworkRequest

  Returns Promise<VPCGW.v2.GatewayNetwork>

  A Promise of GatewayNetwork

getIP

• getIP(request: Readonly<VPCGW.v2.GetIPRequest>): Promise<VPCGW.v2.IP>

• Get an IP. Get details of a Public Gateway flexible IP address, identified by its IP ID. The response object contains information including which (if any) Public Gateway using this IP address, the reverse and various other metadata.

  Parameters

  • request: Readonly<VPCGW.v2.GetIPRequest>

    The request GetIPRequest

  Returns Promise<VPCGW.v2.IP>

  A Promise of IP

getPatRule

• getPatRule(request: Readonly<GetPatRuleRequest>): Promise<PatRule>

• Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response object gives full details of the PAT rule, including the Public Gateway it belongs to and the configuration settings in terms of public / private ports, private IP and protocol.

  Parameters

  • request: Readonly<GetPatRuleRequest>

    The request GetPatRuleRequest

  Returns Promise<PatRule>

  A Promise of PatRule

listGatewayNetworks

• listGatewayNetworks(
      request?: Readonly<VPCGW.v2.ListGatewayNetworksRequest>,
  ): Promise<VPCGW.v2.ListGatewayNetworksResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          VPCGW.v2.GatewayNetwork[],
          void,
          void,
      >;
      all: () => Promise<VPCGW.v2.GatewayNetwork[]>;
  }

• List Public Gateway connections to Private Networks. List the connections between Public Gateways and Private Networks (a connection = a GatewayNetwork). You can choose to filter by gateway-id to list all Private Networks attached to the specified Public Gateway, or by private_network_id to list all Public Gateways attached to the specified Private Network. Other query parameters are also available. The result is an array of GatewayNetwork objects, each giving details of the connection between a given Public Gateway and a given Private Network.

  Parameters

  • request: Readonly<VPCGW.v2.ListGatewayNetworksRequest> = {}

    The request ListGatewayNetworksRequest

  Returns Promise<VPCGW.v2.ListGatewayNetworksResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          VPCGW.v2.GatewayNetwork[],
          void,
          void,
      >;
      all: () => Promise<VPCGW.v2.GatewayNetwork[]>;
  }

  A Promise of ListGatewayNetworksResponse

listGateways

• listGateways(
      request?: Readonly<VPCGW.v2.ListGatewaysRequest>,
  ): Promise<VPCGW.v2.ListGatewaysResponse> & {
      "[asyncIterator]": () => AsyncGenerator<VPCGW.v2.Gateway[], void, void>;
      all: () => Promise<VPCGW.v2.Gateway[]>;
  }

• List Public Gateways. List Public Gateways in a given Scaleway Organization or Project. By default, results are displayed in ascending order of creation date.

  Parameters

  • request: Readonly<VPCGW.v2.ListGatewaysRequest> = {}

    The request ListGatewaysRequest

  Returns Promise<VPCGW.v2.ListGatewaysResponse> & {
      "[asyncIterator]": () => AsyncGenerator<VPCGW.v2.Gateway[], void, void>;
      all: () => Promise<VPCGW.v2.Gateway[]>;
  }

  A Promise of ListGatewaysResponse

listGatewayTypes

• listGatewayTypes(
      request?: Readonly<VPCGW.v2.ListGatewayTypesRequest>,
  ): Promise<VPCGW.v2.ListGatewayTypesResponse>

• List Public Gateway types. List the different Public Gateway commercial offer types available at Scaleway. The response is an array of objects describing the name and technical details of each available gateway type.

  Parameters

  • request: Readonly<VPCGW.v2.ListGatewayTypesRequest> = {}

    The request ListGatewayTypesRequest

  Returns Promise<VPCGW.v2.ListGatewayTypesResponse>

  A Promise of ListGatewayTypesResponse

listIPs

• listIPs(
      request?: Readonly<VPCGW.v2.ListIPsRequest>,
  ): Promise<VPCGW.v2.ListIPsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<VPCGW.v2.IP[], void, void>;
      all: () => Promise<VPCGW.v2.IP[]>;
  }

• List IPs. List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response.

  Parameters

  • request: Readonly<VPCGW.v2.ListIPsRequest> = {}

    The request ListIPsRequest

  Returns Promise<VPCGW.v2.ListIPsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<VPCGW.v2.IP[], void, void>;
      all: () => Promise<VPCGW.v2.IP[]>;
  }

  A Promise of ListIPsResponse

listPatRules

• listPatRules(
      request?: Readonly<ListPatRulesRequest>,
  ): Promise<ListPatRulesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<PatRule[], void, void>;
      all: () => Promise<PatRule[]>;
  }

• List PAT rules. List PAT rules. You can filter by gateway ID to list all PAT rules for a particular gateway, or filter for PAT rules targeting a specific IP address or using a specific protocol.

  Parameters

  • request: Readonly<ListPatRulesRequest> = {}

    The request ListPatRulesRequest

  Returns Promise<ListPatRulesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<PatRule[], void, void>;
      all: () => Promise<PatRule[]>;
  }

  A Promise of ListPatRulesResponse

refreshSSHKeys

• refreshSSHKeys(
      request: Readonly<VPCGW.v2.RefreshSSHKeysRequest>,
  ): Promise<VPCGW.v2.Gateway>

• Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public Gateway, specified by its gateway ID. This adds any new SSH keys in the gateway's Scaleway Project to the gateway itself.

  Parameters

  • request: Readonly<VPCGW.v2.RefreshSSHKeysRequest>

    The request RefreshSSHKeysRequest

  Returns Promise<VPCGW.v2.Gateway>

  A Promise of Gateway

setBastionAllowedIPs

• setBastionAllowedIPs(
      request: Readonly<SetBastionAllowedIPsRequest>,
  ): Promise<SetBastionAllowedIPsResponse>

• Set all IP ranges allowed for SSH bastion. Set a definitive list of IP ranges (in CIDR notation) allowed to connect to the SSH bastion.

  Parameters

  • request: Readonly<SetBastionAllowedIPsRequest>

    The request SetBastionAllowedIPsRequest

  Returns Promise<SetBastionAllowedIPsResponse>

  A Promise of SetBastionAllowedIPsResponse

setPatRules

• setPatRules(request: Readonly<SetPatRulesRequest>): Promise<SetPatRulesResponse>

• Set all PAT rules. Set a definitive list of PAT rules attached to a Public Gateway. Each rule is identified by its public port and protocol. This will sync the current PAT rule list on the gateway with the new list, creating, updating or deleting PAT rules accordingly.

  Parameters

  • request: Readonly<SetPatRulesRequest>

    The request SetPatRulesRequest

  Returns Promise<SetPatRulesResponse>

  A Promise of SetPatRulesResponse

updateGateway

• updateGateway(
      request: Readonly<VPCGW.v2.UpdateGatewayRequest>,
  ): Promise<VPCGW.v2.Gateway>

• Update a Public Gateway. Update the parameters of an existing Public Gateway, for example, its name, tags, SSH bastion configuration, and DNS servers.

  Parameters

  • request: Readonly<VPCGW.v2.UpdateGatewayRequest>

    The request UpdateGatewayRequest

  Returns Promise<VPCGW.v2.Gateway>

  A Promise of Gateway

updateGatewayNetwork

• updateGatewayNetwork(
      request: Readonly<VPCGW.v2.UpdateGatewayNetworkRequest>,
  ): Promise<VPCGW.v2.GatewayNetwork>

• Update a Public Gateway's connection to a Private Network. Update the configuration parameters of a connection between a given Public Gateway and Private Network (the connection = a GatewayNetwork). Updatable parameters include whether to enable traffic masquerade (dynamic NAT).

  Parameters

  • request: Readonly<VPCGW.v2.UpdateGatewayNetworkRequest>

    The request UpdateGatewayNetworkRequest

  Returns Promise<VPCGW.v2.GatewayNetwork>

  A Promise of GatewayNetwork

updateIP

• updateIP(request: Readonly<VPCGW.v2.UpdateIPRequest>): Promise<VPCGW.v2.IP>

• Update an IP. Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to.

  Parameters

  • request: Readonly<VPCGW.v2.UpdateIPRequest>

    The request UpdateIPRequest

  Returns Promise<VPCGW.v2.IP>

  A Promise of IP

updatePatRule

• updatePatRule(request: Readonly<UpdatePatRuleRequest>): Promise<PatRule>

• Update a PAT rule. Update a PAT rule, specified by its PAT rule ID. Configuration settings including private/public port, private IP address and protocol can all be updated.

  Parameters

  • request: Readonly<UpdatePatRuleRequest>

    The request UpdatePatRuleRequest

  Returns Promise<PatRule>

  A Promise of PatRule

upgradeGateway

• upgradeGateway(
      request: Readonly<VPCGW.v2.UpgradeGatewayRequest>,
  ): Promise<VPCGW.v2.Gateway>

• Upgrade a Public Gateway to the latest version and/or to a different commercial offer type. Upgrade a given Public Gateway to the newest software version or to a different commercial offer type. This applies the latest bugfixes and features to your Public Gateway. Note that gateway service will be interrupted during the update.

  Parameters

  • request: Readonly<VPCGW.v2.UpgradeGatewayRequest>

    The request UpgradeGatewayRequest

  Returns Promise<VPCGW.v2.Gateway>

  A Promise of Gateway

waitForGateway

• waitForGateway(
      request: Readonly<VPCGW.v2.GetGatewayRequest>,
      options?: Readonly<WaitForOptions<VPCGW.v2.Gateway>>,
  ): Promise<VPCGW.v2.Gateway>

• Waits for Gateway to be in a final state.

  Parameters

  • request: Readonly<VPCGW.v2.GetGatewayRequest>

    The request GetGatewayRequest
  • Optionaloptions: Readonly<WaitForOptions<VPCGW.v2.Gateway>>

    The waiting options

  Returns Promise<VPCGW.v2.Gateway>

  A Promise of Gateway

waitForGatewayNetwork

• waitForGatewayNetwork(
      request: Readonly<VPCGW.v2.GetGatewayNetworkRequest>,
      options?: Readonly<WaitForOptions<VPCGW.v2.GatewayNetwork>>,
  ): Promise<VPCGW.v2.GatewayNetwork>

• Waits for GatewayNetwork to be in a final state.

  Parameters

  • request: Readonly<VPCGW.v2.GetGatewayNetworkRequest>

    The request GetGatewayNetworkRequest
  • Optionaloptions: Readonly<WaitForOptions<VPCGW.v2.GatewayNetwork>>

    The waiting options

  Returns Promise<VPCGW.v2.GatewayNetwork>

  A Promise of GatewayNetwork