Class WireGuardService

WireGuard service

Hierarchy (View Summary)

BaseService
- WireGuardService

Index

Constructors

Properties

apiClient axiosInstance

Methods

activateTunnel createTunnel deactivateTunnel deleteTunnel disableTunnel enableTunnel generateKeyPair getTunnel listTunnels updateTunnel

Constructors

constructor

new WireGuardService(apiClient: Client): WireGuardService
Constructor
Parameters
- apiClient: Client
  API client
Returns WireGuardService
Inherited from BaseService.constructor
- Defined in services/BaseService.ts:42

Properties

`Protected` `Readonly`apiClient

apiClient: Client

`Protected` `Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

activateTunnel

activateTunnel(id: number): Promise<void>
Activates an existing WireGuard tunnel
Parameters
- id: number
  WireGuard tunnel ID
Returns Promise<void>
- Defined in services/Network/WireGuardService.ts:93

createTunnel

createTunnel(config: WireGuardTunnelConfig): Promise<void>
Creates a new WireGuard tunnel
Parameters
- config: WireGuardTunnelConfig
  WireGuard tunnel configuration
Returns Promise<void>
- Defined in services/Network/WireGuardService.ts:57

deactivateTunnel

deactivateTunnel(id: number): Promise<void>
Deactivates an existing WireGuard tunnel
Parameters
- id: number
  WireGuard tunnel ID
Returns Promise<void>
- Defined in services/Network/WireGuardService.ts:101

deleteTunnel

deleteTunnel(id: number): Promise<void>
Deletes an existing WireGuard tunnel
Parameters
- id: number
  WireGuard tunnel ID
Returns Promise<void>
- Defined in services/Network/WireGuardService.ts:74

disableTunnel

disableTunnel(id: number): Promise<void>
Disables an existing WireGuard tunnel
Parameters
- id: number
  WireGuard tunnel ID
Returns Promise<void>
- Defined in services/Network/WireGuardService.ts:117

enableTunnel

enableTunnel(id: number): Promise<void>
Enables an existing WireGuard tunnel
Parameters
- id: number
  WireGuard tunnel ID
Returns Promise<void>
- Defined in services/Network/WireGuardService.ts:109

generateKeyPair

generateKeyPair(): Promise<WireGuardKeyPair>
Generates a new WireGuard key-pair

Returns Promise<WireGuardKeyPair>
WireGuard key-pair
- Defined in services/Network/WireGuardService.ts:37

getTunnel

getTunnel(id: number): Promise<WireGuardTunnelConfig>
Retrieves an existing WireGuard tunnel configuration
Parameters
- id: number
  WireGuard tunnel ID
Returns Promise<WireGuardTunnelConfig>
WireGuard tunnel configuration
- Defined in services/Network/WireGuardService.ts:83

listTunnels

listTunnels(): Promise<WireGuardTunnelListEntry[]>
Retrieves a list of existing WireGuard tunnels

Returns Promise<WireGuardTunnelListEntry[]>
List of existing WireGuard tunnels
- Defined in services/Network/WireGuardService.ts:47

updateTunnel

updateTunnel(id: number, config: WireGuardTunnelConfig): Promise<void>
Updates an existing WireGuard tunnel
Parameters
- id: number
  WireGuard tunnel ID
- config: WireGuardTunnelConfig
  WireGuard tunnel configuration
Returns Promise<void>
- Defined in services/Network/WireGuardService.ts:66