Class API

constructor

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

• Parameters

  • client: Client

  Returns VPCGW.v1.API

Static ReadonlyLOCALITIES

createDHCP

• createDHCP(request: Readonly<CreateDHCPRequest>): Promise<DHCP>

• Create a DHCP configuration. Create a new DHCP configuration object, containing settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. The response object includes the ID of the DHCP configuration object. You can use this ID as part of a call to Create a Public Gateway connection to a Private Network or Update a Public Gateway connection to a Private Network to directly apply this DHCP configuration.

  Parameters

  • request: Readonly<CreateDHCPRequest>

    The request CreateDHCPRequest

  Returns Promise<DHCP>

  A Promise of DHCP

createDHCPEntry

• createDHCPEntry(request: Readonly<CreateDHCPEntryRequest>): Promise<DHCPEntry>

• Create a DHCP entry. Create a static DHCP reservation, specifying the Gateway Network for the reservation, the MAC address of the target device and the IP address to assign this device. The response is a DHCP entry object, confirming the ID and configuration details of the static DHCP reservation.

  Parameters

  • request: Readonly<CreateDHCPEntryRequest>

    The request CreateDHCPEntryRequest

  Returns Promise<DHCPEntry>

  A Promise of DHCPEntry

createGateway

• createGateway(
      request: Readonly<VPCGW.v1.CreateGatewayRequest>,
  ): Promise<VPCGW.v1.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.v1.CreateGatewayRequest>

    The request CreateGatewayRequest

  Returns Promise<VPCGW.v1.Gateway>

  A Promise of Gateway

createGatewayNetwork

• createGatewayNetwork(
      request: Readonly<VPCGW.v1.CreateGatewayNetworkRequest>,
  ): Promise<VPCGW.v1.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 DHCP settings, whether to enable masquerade (dynamic NAT), and more.

  Parameters

  • request: Readonly<VPCGW.v1.CreateGatewayNetworkRequest>

    The request CreateGatewayNetworkRequest

  Returns Promise<VPCGW.v1.GatewayNetwork>

  A Promise of GatewayNetwork

createIP

• createIP(request?: Readonly<VPCGW.v1.CreateIPRequest>): Promise<VPCGW.v1.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.v1.CreateIPRequest> = {}

    The request CreateIPRequest

  Returns Promise<VPCGW.v1.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

deleteDHCP

• deleteDHCP(request: Readonly<DeleteDHCPRequest>): Promise<void>

• Delete a DHCP configuration. Delete a DHCP configuration object, identified by its DHCP ID. Note that you cannot delete a DHCP configuration object that is currently being used by a Gateway Network.

  Parameters

  • request: Readonly<DeleteDHCPRequest>

    The request DeleteDHCPRequest

  Returns Promise<void>

deleteDHCPEntry

• deleteDHCPEntry(request: Readonly<DeleteDHCPEntryRequest>): Promise<void>

• Delete a DHCP entry. Delete a static DHCP reservation, identified by its DHCP entry ID. Note that you cannot delete DHCP entries of type lease, these are deleted automatically when their time-to-live expires.

  Parameters

  • request: Readonly<DeleteDHCPEntryRequest>

    The request DeleteDHCPEntryRequest

  Returns Promise<void>

deleteGateway

• deleteGateway(request: Readonly<VPCGW.v1.DeleteGatewayRequest>): Promise<void>

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

  Parameters

  • request: Readonly<VPCGW.v1.DeleteGatewayRequest>

    The request DeleteGatewayRequest

  Returns Promise<void>

deleteGatewayNetwork

• deleteGatewayNetwork(
      request: Readonly<VPCGW.v1.DeleteGatewayNetworkRequest>,
  ): Promise<void>

• 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.v1.DeleteGatewayNetworkRequest>

    The request DeleteGatewayNetworkRequest

  Returns Promise<void>

deleteIP

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

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

  Parameters

  • request: Readonly<VPCGW.v1.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>

enableIPMobility

• enableIPMobility(request: Readonly<EnableIPMobilityRequest>): Promise<void>

• Upgrade a Public Gateway to IP mobility. Upgrade a Public Gateway to IP mobility (move from NAT IP to routed IP). This is idempotent: repeated calls after the first will return no error but have no effect.

  Parameters

  • request: Readonly<EnableIPMobilityRequest>

    The request EnableIPMobilityRequest

  Returns Promise<void>

getDHCP

• getDHCP(request: Readonly<GetDHCPRequest>): Promise<DHCP>

• Get a DHCP configuration. Get a DHCP configuration object, identified by its DHCP ID. The response object contains configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the List Public Gateway connections to Private Networks method for that purpose, filtering on DHCP ID.

  Parameters

  • request: Readonly<GetDHCPRequest>

    The request GetDHCPRequest

  Returns Promise<DHCP>

  A Promise of DHCP

getDHCPEntry

• getDHCPEntry(request: Readonly<GetDHCPEntryRequest>): Promise<DHCPEntry>

• Get a DHCP entry. Get a DHCP entry, specified by its DHCP entry ID.

  Parameters

  • request: Readonly<GetDHCPEntryRequest>

    The request GetDHCPEntryRequest

  Returns Promise<DHCPEntry>

  A Promise of DHCPEntry

getGateway

• getGateway(
      request: Readonly<VPCGW.v1.GetGatewayRequest>,
  ): Promise<VPCGW.v1.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.v1.GetGatewayRequest>

    The request GetGatewayRequest

  Returns Promise<VPCGW.v1.Gateway>

  A Promise of Gateway

getGatewayNetwork

• getGatewayNetwork(
      request: Readonly<VPCGW.v1.GetGatewayNetworkRequest>,
  ): Promise<VPCGW.v1.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.v1.GetGatewayNetworkRequest>

    The request GetGatewayNetworkRequest

  Returns Promise<VPCGW.v1.GatewayNetwork>

  A Promise of GatewayNetwork

getIP

• getIP(request: Readonly<VPCGW.v1.GetIPRequest>): Promise<VPCGW.v1.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.v1.GetIPRequest>

    The request GetIPRequest

  Returns Promise<VPCGW.v1.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

listDHCPEntries

• listDHCPEntries(
      request?: Readonly<ListDHCPEntriesRequest>,
  ): Promise<ListDHCPEntriesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<DHCPEntry[], void, void>;
      all: () => Promise<DHCPEntry[]>;
  }

• List DHCP entries. List DHCP entries, whether dynamically assigned and/or statically reserved. DHCP entries can be filtered by the Gateway Network they are on, their MAC address, IP address, type or hostname.

  Parameters

  • request: Readonly<ListDHCPEntriesRequest> = {}

    The request ListDHCPEntriesRequest

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

  A Promise of ListDHCPEntriesResponse

listDHCPs

• listDHCPs(
      request?: Readonly<ListDHCPsRequest>,
  ): Promise<ListDHCPsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<DHCP[], void, void>;
      all: () => Promise<DHCP[]>;
  }

• List DHCP configurations. List DHCP configurations, optionally filtering by Organization, Project, Public Gateway IP address or more. The response is an array of DHCP configuration objects, each identified by a DHCP ID and containing configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the List Public Gateway connections to Private Networks method for that purpose, filtering on DHCP ID.

  Parameters

  • request: Readonly<ListDHCPsRequest> = {}

    The request ListDHCPsRequest

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

  A Promise of ListDHCPsResponse

listGatewayNetworks

• listGatewayNetworks(
      request?: Readonly<VPCGW.v1.ListGatewayNetworksRequest>,
  ): Promise<VPCGW.v1.ListGatewayNetworksResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          VPCGW.v1.GatewayNetwork[],
          void,
          void,
      >;
      all: () => Promise<VPCGW.v1.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.v1.ListGatewayNetworksRequest> = {}

    The request ListGatewayNetworksRequest

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

  A Promise of ListGatewayNetworksResponse

listGateways

• listGateways(
      request?: Readonly<VPCGW.v1.ListGatewaysRequest>,
  ): Promise<VPCGW.v1.ListGatewaysResponse> & {
      "[asyncIterator]": () => AsyncGenerator<VPCGW.v1.Gateway[], void, void>;
      all: () => Promise<VPCGW.v1.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.v1.ListGatewaysRequest> = {}

    The request ListGatewaysRequest

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

  A Promise of ListGatewaysResponse

listGatewayTypes

• listGatewayTypes(
      request?: Readonly<VPCGW.v1.ListGatewayTypesRequest>,
  ): Promise<VPCGW.v1.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.v1.ListGatewayTypesRequest> = {}

    The request ListGatewayTypesRequest

  Returns Promise<VPCGW.v1.ListGatewayTypesResponse>

  A Promise of ListGatewayTypesResponse

listIPs

• listIPs(
      request?: Readonly<VPCGW.v1.ListIPsRequest>,
  ): Promise<VPCGW.v1.ListIPsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<VPCGW.v1.IP[], void, void>;
      all: () => Promise<VPCGW.v1.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.v1.ListIPsRequest> = {}

    The request ListIPsRequest

  Returns Promise<VPCGW.v1.ListIPsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<VPCGW.v1.IP[], void, void>;
      all: () => Promise<VPCGW.v1.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.v1.RefreshSSHKeysRequest>,
  ): Promise<VPCGW.v1.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.v1.RefreshSSHKeysRequest>

    The request RefreshSSHKeysRequest

  Returns Promise<VPCGW.v1.Gateway>

  A Promise of Gateway

setDHCPEntries

• setDHCPEntries(
      request: Readonly<SetDHCPEntriesRequest>,
  ): Promise<SetDHCPEntriesResponse>

• Set all DHCP reservations on a Gateway Network. Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries accordingly.

  Parameters

  • request: Readonly<SetDHCPEntriesRequest>

    The request SetDHCPEntriesRequest

  Returns Promise<SetDHCPEntriesResponse>

  A Promise of SetDHCPEntriesResponse

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

updateDHCP

• updateDHCP(request: Readonly<UpdateDHCPRequest>): Promise<DHCP>

• Update a DHCP configuration. Update a DHCP configuration object, identified by its DHCP ID.

  Parameters

  • request: Readonly<UpdateDHCPRequest>

    The request UpdateDHCPRequest

  Returns Promise<DHCP>

  A Promise of DHCP

updateDHCPEntry

• updateDHCPEntry(request: Readonly<UpdateDHCPEntryRequest>): Promise<DHCPEntry>

• Update a DHCP entry. Update the IP address for a DHCP entry, specified by its DHCP entry ID. You can update an existing DHCP entry of any type (reservation (static), lease (dynamic) or unknown), but in manually updating the IP address the entry will necessarily be of type reservation after the update.

  Parameters

  • request: Readonly<UpdateDHCPEntryRequest>

    The request UpdateDHCPEntryRequest

  Returns Promise<DHCPEntry>

  A Promise of DHCPEntry

updateGateway

• updateGateway(
      request: Readonly<VPCGW.v1.UpdateGatewayRequest>,
  ): Promise<VPCGW.v1.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.v1.UpdateGatewayRequest>

    The request UpdateGatewayRequest

  Returns Promise<VPCGW.v1.Gateway>

  A Promise of Gateway

updateGatewayNetwork

• updateGatewayNetwork(
      request: Readonly<VPCGW.v1.UpdateGatewayNetworkRequest>,
  ): Promise<VPCGW.v1.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 DHCP settings and whether to enable traffic masquerade (dynamic NAT).

  Parameters

  • request: Readonly<VPCGW.v1.UpdateGatewayNetworkRequest>

    The request UpdateGatewayNetworkRequest

  Returns Promise<VPCGW.v1.GatewayNetwork>

  A Promise of GatewayNetwork

updateIP

• updateIP(request: Readonly<VPCGW.v1.UpdateIPRequest>): Promise<VPCGW.v1.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.v1.UpdateIPRequest>

    The request UpdateIPRequest

  Returns Promise<VPCGW.v1.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.v1.UpgradeGatewayRequest>,
  ): Promise<VPCGW.v1.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.v1.UpgradeGatewayRequest>

    The request UpgradeGatewayRequest

  Returns Promise<VPCGW.v1.Gateway>

  A Promise of Gateway

waitForGateway

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

• Waits for Gateway to be in a final state.

  Parameters

  • request: Readonly<VPCGW.v1.GetGatewayRequest>

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

    The waiting options

  Returns Promise<VPCGW.v1.Gateway>

  A Promise of Gateway

waitForGatewayNetwork

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

• Waits for GatewayNetwork to be in a final state.

  Parameters

  • request: Readonly<VPCGW.v1.GetGatewayNetworkRequest>

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

    The waiting options

  Returns Promise<VPCGW.v1.GatewayNetwork>

  A Promise of GatewayNetwork