Class ServersAPI

Handles generic Server interaction, such as Sending Commands, managing Power State, and getting Details

Index

Constructors

Properties

Methods

GetDetails GetResources GetWebsocketDetails PowerRequest SendCommand SetName

Constructors

constructor

new ServersAPI(core): ServersAPI
Parameters
- core: WispAPICore
Returns ServersAPI
- Defined in wisp_api/apis/servers.ts:77

Properties

`Private` core

core: WispAPICore

Methods

GetDetails

GetDetails(): Promise<GetDetailsResponse>
Retrieves the basic, technical details of the Server

Returns Promise<GetDetailsResponse>
- Defined in wisp_api/apis/servers.ts:122

GetResources

GetResources(): Promise<GetResourcesResponse>
Retrieves technical details of the Server's resources (CPU, Memory, Disk, Network)

Returns Promise<GetResourcesResponse>
- Defined in wisp_api/apis/servers.ts:133

GetWebsocketDetails

GetWebsocketDetails(): Promise<GetWebsocketDetailsResponse>
Gets the Websocket connection (and upload) details for the Server

Returns Promise<GetWebsocketDetailsResponse>
- Defined in wisp_api/apis/servers.ts:97

PowerRequest

PowerRequest(action): Promise<void>
Instructs the Server to start up, shut down, restart, or force quit
Parameters
- action: PowerRequest
  The power action to send. One of: ["start", "stop", "restart", "kill"]
Returns Promise<void>
Example
Example of stopping the server
```
await wisp.api.PowerRequest("stop");
```
- Defined in wisp_api/apis/servers.ts:152

SendCommand

SendCommand(command): Promise<void>
Sends a command to the Server
Parameters
- command: string
  The full command string to send to the Server
Returns Promise<void>
- Defined in wisp_api/apis/servers.ts:87

SetName

SetName(name): Promise<GetDetailsResponse>
Sets the name of the Server as it appears in the panel (Same thing as setting the name in the "Server Details" menu)
Parameters
- name: string
  The new name of the server
Returns Promise<GetDetailsResponse>
- Defined in wisp_api/apis/servers.ts:111

Generated using TypeDoc