Class ClientServersModule

Index

Constructors

Methods

getServer getUsage getWebsocket

Constructors

constructor

new ClientServersModule(client: PteroClient): ClientServersModule
Parameters
- client: PteroClient
Returns ClientServersModule
- Defined in src/modules/ClientServersModule.ts:14

Methods

getServer

getServer(
data: IdentifierRequest,
include?: IncludeParameters[],
): Promise<Server>
Retrieves the details of a specific server by its identifier.
Parameters
- data: IdentifierRequest
  The server request data containing the identifier of the server to retrieve.
- Optionalinclude: IncludeParameters[]
Returns Promise<Server>
- A promise that resolves to the server details.
Example
```
const server = await ptero.servers.getServer({ identifier: "server-identifier" }, [IncludeParameters.EGG, IncludeParameters.SUBUSERS]);
console.log(server);
```
- Defined in src/modules/ClientServersModule.ts:30

getUsage

getUsage(data: IdentifierRequest): Promise<ServerResources>
Retrieves the resource usage statistics for a specific server. This includes memory, CPU, disk, and network usage.
Parameters
- data: IdentifierRequest
  The request data containing the identifier of the server to retrieve usage statistics for.
Returns Promise<ServerResources>
- A promise that resolves to the resource usage statistics of the specified server.
Example
```
const usage = await ptero.servers.getUsage({ identifier: "server-identifier" });
console.log(usage);
```
- Defined in src/modules/ClientServersModule.ts:62

getWebsocket

getWebsocket(data: IdentifierRequest): Promise<Websocket>
Parameters
- data: IdentifierRequest
  The request data containing the identifier of the server to retrieve the websocket for.
Returns Promise<Websocket>
- A promise that resolves to the websocket details for the specified server.
Example
```
const socket = await ptero.servers.getWebsocket({identifier: "1b76beeb"});
  console.log(socket);
```
- Defined in src/modules/ClientServersModule.ts:47