Pterodactyl.ts

https://pterots.bothimtv.com
Admin
A TypeScript API wrapper for the Pterodactyl panel, allowing management of servers, users, files,...
Tokens:45,699
Snippets:140
Trust Score:4.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Server When Installed Configuration

Source: https://pterots.bothimtv.com/classes/ServerBuilder

Configures the server to automatically start after the installation process is complete. This method takes a boolean value to enable or disable this behavior.

```typescript
startServerWhenInstalled(start: boolean): ServerBuilder {
  // Implementation details...
  return this;
}

// Example Usage:
// serverBuilder.startServerWhenInstalled(true);
```

```plaintext
start true
```

--------------------------------

### Startup Command

Source: https://pterots.bothimtv.com/classes/Egg

Specifies the command used to start the application within the egg's container.

```APIDOC
startup: string

Description: The command executed to start the service within the container.
```

--------------------------------

### Create Server Backup with UserClient

Source: https://pterots.bothimtv.com/index

Provides an example of creating a server backup using the BackupBuilder and UserClient. It allows setting a backup name, locking the backup, and specifying ignored directories.

```typescript
const newBackup = new BackupBuilder()
  .setName('Backup of server')
  .setLocked(true)
  .setIgnored(['logs', 'cache']);

server.createBackup(newBackup);
```

--------------------------------

### Console and Command Execution

Source: https://pterots.bothimtv.com/classes/Server

APIs for interacting with the server's console, including getting a WebSocket connection for real-time console output and sending commands to the server.

```APIDOC
getConsoleSocket(): Promise<WebSocket>
  Establishes and returns a WebSocket connection for real-time console output.
  Returns: Promise<WebSocket> instance.

sendCommand(command: string): Promise<void>
  Sends a command to be executed within the server's console.
  Parameters:
    command: The command string to send (e.g., 'say Hello World').
  Returns: Promise<void>
```

--------------------------------

### Server State Management

Source: https://pterots.bothimtv.com/classes/Server

Methods for controlling the operational state of a server, such as starting, stopping, restarting, and killing the server process. Also includes methods for reinstalling the server and retrieving its current status.

```APIDOC
start(): Promise<void>
  Starts the server.
  Returns: Promise<void>

stop(): Promise<void>
  Stops the server.
  Returns: Promise<void>

restart(): Promise<void>
  Restarts the server.
  Returns: Promise<void>

kill(): Promise<void>
  Kills the server process.
  Returns: Promise<void>

reinstall(): Promise<void>
  Reinstalls the server.
  Returns: Promise<void>

getStatus(): Promise<string>
  Retrieves the current status of the server (e.g., 'running', 'stopped').
  Returns: Promise<string> representing the server status.
```

--------------------------------

### Manage Server Files with UserClient

Source: https://pterots.bothimtv.com/index

Details how to upload, read, download, and compress files on a server using the UserClient. It shows operations like uploading a file, listing directory contents, getting file content, download URLs, and compressing files.

```typescript
import fs from 'fs';

const server = await userClient.getServer('someId');

// Accepts a filepath, buffer or blob
await server.uploadFile('/', 'hello.world', 'hello.world');

server.getFiles('/').then((files) => {
  console.log('Files in "/": ' + files.map((file) => file.name).join(', '));

  const helloWorldFile = files.find((file) => file.name === 'hello.world');
  if (!helloWorldFile) {
    console.error('File not found');
    return;
  }

  helloWorldFile.getContent().then((contents) => {
    console.log('Contents of hello.world: ' + contents);
  });

  helloWorldFile.downloadUrl().then((url) => {
    console.log('You can download hello.world via: ' + url);
  });

  helloWorldFile.compress().then(async (archive) => {
    console.log('Compressed hello.world');
    await archive.downloadStream().then((stream) => {
      stream.pipe(fs.createWriteStream('hello.world.tar.gz'));
    });
    archive.delete();
  });
});
```

--------------------------------

### PanelServer API Methods

Source: https://pterots.bothimtv.com/classes/PanelServer

Provides documentation for methods to configure and manage server settings, including I/O limits, memory, name, startup commands, and server state (suspend/unsuspend). These methods are part of the PanelServer class.

```APIDOC
setIoLimit(limit: number): Promise<void>
  Set the io limit for this server.
  Parameters:
    limit: number - The new io limit, number between 10 and 1000.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:336
```

```APIDOC
setMemoryLimit(limit: number): Promise<void>
  Set the new memory limit.
  Parameters:
    limit: number - The new memory limit in MiB.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:283
```

```APIDOC
setName(name: string): Promise<void>
  Set the name for this server.
  Parameters:
    name: string - The new name for this server.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:151
```

```APIDOC
setNestAndEgg(nest: number | Nest, egg: number | Egg): Promise<void>
  Set the new nest for this server.
  Parameters:
    nest: number | [Nest](Nest.html) - The new nest for this server.
    egg: number | [Egg](Egg.html) - The new egg for this server.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:504
```

```APIDOC
setOomKillerState(active: boolean): Promise<void>
  Enable the OOM killer. This will kill the server if it exceeds the memory limit. This may cause the server processes to exit unexpectedly. This CAN cause to data corruption.
  Parameters:
    active: boolean - Should the oom killer be active.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:356
```

```APIDOC
setOwner(owner: number | PanelUser): Promise<void>
  Set the owner for this server.
  Parameters:
    owner: number | [PanelUser](PanelUser.html) - The ownerId or the User object.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:185
```

```APIDOC
setSkipInstall(skip: boolean): Promise<void>
  Skip install script.
  Parameters:
    skip: boolean - Whether the install script should be skipped.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:522
```

```APIDOC
setStartupCommand(startup: string): Promise<void>
  Set the startup command with which the server will start. This can include environment vars via {{ VAR_NAME }}.
  Parameters:
    startup: string
  Returns: Promise<void>
  Default:
  startup This will use the default startup command if you set the egg via .setEgg(egg: PanelEgg)
  Defined in src/ApplicationClient/PanelServer.ts:486
```

```APIDOC
setSwapLimit(limit: number): Promise<void>
  Set the new swap limit.
  Parameters:
    limit: number - The new swap limit in MiB.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:300
```

```APIDOC
suspend(): Promise<void>
  Suspend this server.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:606
```

```APIDOC
unsuspend(): Promise<void>
  Unsuspend this server.
  Returns: Promise<void>
  Defined in src/ApplicationClient/PanelServer.ts:615
```

--------------------------------

### APIDOC: Restart Server

Source: https://pterots.bothimtv.com/classes/Server

Restarts the server process. This action will stop and then start the server.

```APIDOC
restart(): Promise<void>
  * Restart this server
  * Defined in src/UserClient/Server.ts:168
```

--------------------------------

### PanelServer Configuration Methods

Source: https://pterots.bothimtv.com/classes/PanelServer

Methods for configuring various server settings such as allocation limits, backup limits, CPU usage, disk space, description, environment variables, and Docker images.

```APIDOC
setAllocationLimit(limit: number): Promise<void>
  Sets the new allocation limit for the server.
  Parameters:
    limit: number - How many allocations can be created for this server.

setBackupLimit(limit: number): Promise<void>
  Sets the new backup limit for the server.
  Parameters:
    limit: number - How many backups can be created for this server.

setCpuLimit(limit: number): Promise<void>
  Sets the maximum CPU usage for this server. Set to 0 for no CPU limit.
  To allow using all cores on a node with N cores, set limit to N * 100.
  Parameters:
    limit: number - The new CPU limit in percentage.

setCpuPinning(pinning: string | (string | number)[]): Promise<void>
  Sets which CPU cores can be used by a server. Supports formats like '0', '1-3', '4,5,6'.
  Parameters:
    pinning: string | (string | number)[] - A string or array specifying the CPU cores.

setCustomDockerImage(image: string): Promise<void>
  Sets a custom Docker image for the server.
  Parameters:
    image: string - The new Docker image name for the container.

setDatabaseLimit(limit: number): Promise<void>
  Sets the new database limit for the server.
  Parameters:
    limit: number - How many databases can be created for this server.

setDescription(description: string): Promise<void>
  Sets the description for the server.
  Parameters:
    description: string - The new description for this server.

setDiskLimit(limit: number): Promise<void>
  Sets the new disk limit for the server.
  Parameters:
    limit: number - The new disk limit in MiB.

setDockerImage(image: string): Promise<void>
  Sets the Docker image for the server.
  Parameters:
    image: string - The new Docker image name for the container.

setEnvironment(environment: { [environment: string]: string }): Promise<void>
  Sets the environment variables with which the server will start, overwriting all current variables.
  Parameters:
    environment: { [environment: string]: string } - An object where keys are environment variable names and values are their string representations.

setExternalId(externalId: string): Promise<void>
  Sets the external ID for the server.
  Parameters:
    externalId: string - The new external ID for this server.
```

--------------------------------

### PanelServer Environment Variable Management

Source: https://pterots.bothimtv.com/classes/PanelServer

Adds or updates environment variables for the server. These variables are used when the server starts.

```APIDOC
addEnvironmentVariable(key, value): Promise<void>
  Add environment vars with which the server will start.

  Parameters:
    key: string
    value: string

  Returns: Promise<void>
```

--------------------------------

### Create Server with ApplicationClient

Source: https://pterots.bothimtv.com/index

Illustrates creating a new server using ServerBuilder and ApplicationClient. This includes setting server name, description, owner, allocation, resource limits, and feature limits.

```typescript
const newServer = new ServerBuilder()
  .setName('Hello world!')
  .setDescription('This is my fancy game server')
  .setOwnerId(1) // The user id for the owner
  .setAllocationId(1) // The allocation id for the server
  .setLimits({
    memory: 512,
    swap: 0,
    disk: 5120,
    io: 500,
    cpu: 100,
    threads: undefined,
  })
  .setFeatureLimits({
    databases: 1,
    backups: 5,
    allocations: 2,
  });
// TODO Env setup (variables, egg, etc.)

await applicationClient.createServer(newServer).then((server) => {
  console.log('The server is currently ' + server.status);
});
```

--------------------------------

### APIDOC: Get Server Status

Source: https://pterots.bothimtv.com/classes/Server

Fetches the current status of the server. The status is returned as a ServerStatus enum or type.

```APIDOC
getStatus(): Promise<[ServerStatus](../types/ServerStatus.html)>
  * Get the status of this server
  * Defined in src/UserClient/Server.ts:118
```

--------------------------------

### ApplicationClient API Reference

Source: https://pterots.bothimtv.com/classes/ApplicationClient

Provides comprehensive documentation for the ApplicationClient class, including its constructor and methods for interacting with the Pterodactyl Panel API. Covers resource creation and retrieval for locations, nodes, servers, and users.

```APIDOC
ApplicationClient:
  constructor(options: ClientOptions): ApplicationClient
    Parameters:
      options: ClientOptions - Configuration options for the client.
    Returns: ApplicationClient - An instance of ApplicationClient.
    Description: Initializes the ApplicationClient, inheriting from BaseClient.
    Defined in src/ApplicationClient/ApplicationClient.ts:20

  createLocation(locationProperties): Promise<PanelLocation>
    Description: Creates a new location for the Pterodactyl Panel.
    Parameters:
      locationProperties: LocationBuilder - The properties for the new location.
    Returns: Promise<PanelLocation> - The created location object.
    Defined in src/ApplicationClient/ApplicationClient.ts:139

  createNode(nodeProperties): Promise<PanelNode>
    Description: Creates a new node in the Pterodactyl Panel.
    Parameters:
      nodeProperties: NodeBuilder - The properties for the new node.
    Returns: Promise<PanelNode> - The created node object.
    Defined in src/ApplicationClient/ApplicationClient.ts:107

  createServer(serverProperties): Promise<PanelServer>
    Description: Creates a new server in the Pterodactyl Panel.
    Parameters:
      serverProperties: ServerBuilder - The properties for the new server.
    Returns: Promise<PanelServer> - The created server object.
    Defined in src/ApplicationClient/ApplicationClient.ts:191

  createUser(userProperties): Promise<PanelUser>
    Description: Creates a new user in the Pterodactyl Panel.
    Parameters:
      userProperties: UserBuilder - Construct a user via new UserBuilder().
    Returns: Promise<PanelUser> - The created user object.
    Defined in src/ApplicationClient/ApplicationClient.ts:72

  getEgg(eggId): Promise<any>
    Description: Retrieves a specific egg by its ID.
    Parameters:
      eggId: number | string - The ID of the egg to retrieve.
    Returns: Promise<any> - The egg data.
    Defined in src/ApplicationClient/ApplicationClient.ts:219

  getEggs(): Promise<any[]>
    Description: Retrieves a list of all eggs.
    Returns: Promise<any[]> - An array of egg data.
    Defined in src/ApplicationClient/ApplicationClient.ts:233

  getExternalServer(serverExternalId): Promise<any>
    Description: Retrieves a server using its external ID.
    Parameters:
      serverExternalId: string - The external ID of the server.
    Returns: Promise<any> - The server data.
    Defined in src/ApplicationClient/ApplicationClient.ts:261

  getExternalUser(userExternalId): Promise<any>
    Description: Retrieves a user using their external ID.
    Parameters:
      userExternalId: string - The external ID of the user.
    Returns: Promise<any> - The user data.
    Defined in src/ApplicationClient/ApplicationClient.ts:247

  getLocation(locationId): Promise<any>
    Description: Retrieves a specific location by its ID.
    Parameters:
      locationId: number | string - The ID of the location to retrieve.
    Returns: Promise<any> - The location data.
    Defined in src/ApplicationClient/ApplicationClient.ts:153

  getLocations(): Promise<any[]>
    Description: Retrieves a list of all locations.
    Returns: Promise<any[]> - An array of location data.
    Defined in src/ApplicationClient/ApplicationClient.ts:167

  getNest(nestId): Promise<any>
    Description: Retrieves a specific nest by its ID.
    Parameters:
      nestId: number | string - The ID of the nest to retrieve.
    Returns: Promise<any> - The nest data.
    Defined in src/ApplicationClient/ApplicationClient.ts:290

  getNests(): Promise<any[]>
    Description: Retrieves a list of all nests.
    Returns: Promise<any[]> - An array of nest data.
    Defined in src/ApplicationClient/ApplicationClient.ts:304

  getNode(nodeId): Promise<any>
    Description: Retrieves a specific node by its ID.
    Parameters:
      nodeId: number | string - The ID of the node to retrieve.
    Returns: Promise<any> - The node data.
    Defined in src/ApplicationClient/ApplicationClient.ts:93

  getNodes(): Promise<any[]>
    Description: Retrieves a list of all nodes.
    Returns: Promise<any[]> - An array of node data.
    Defined in src/ApplicationClient/ApplicationClient.ts:107

  getServer(serverId): Promise<any>
    Description: Retrieves a specific server by its ID.
    Parameters:
      serverId: number | string - The ID of the server to retrieve.
    Returns: Promise<any> - The server data.
    Defined in src/ApplicationClient/ApplicationClient.ts:180

  getServers(): Promise<any[]>
    Description: Retrieves a list of all servers.
    Returns: Promise<any[]> - An array of server data.
    Defined in src/ApplicationClient/ApplicationClient.ts:191

  getUser(userId): Promise<any>
    Description: Retrieves a specific user by their ID.
    Parameters:
      userId: number | string - The ID of the user to retrieve.
    Returns: Promise<any> - The user data.
    Defined in src/ApplicationClient/ApplicationClient.ts:58

  getUsers(): Promise<any[]>
    Description: Retrieves a list of all users.
    Returns: Promise<any[]> - An array of user data.
    Defined in src/ApplicationClient/ApplicationClient.ts:72
```

--------------------------------

### ServerStatus Type Alias

Source: https://pterots.bothimtv.com/types/ServerStatus

Defines the possible states for a server. Includes 'starting', 'stopping', 'online', and 'offline'. This type is defined in src/types/base/serverStatus.ts.

```typescript
type ServerStatus =
    | "starting"
    | "stopping"
    | "online"
    | "offline";
```

--------------------------------

### APIDOC: Reinstall Server

Source: https://pterots.bothimtv.com/classes/Server

Initiates the server reinstallation process. This will typically reset the server to its default state.

```APIDOC
reinstall(): Promise<void>
  * Reinstall this server
  * Defined in src/UserClient/Server.ts:511
```

--------------------------------

### APIDOC: Get All Subusers

Source: https://pterots.bothimtv.com/classes/Server

Retrieves a list of all subusers associated with the server. This method returns a promise that resolves to an array of SubUser objects.

```APIDOC
getSubusers(): Promise<[SubUser](SubUser.html)[]>
  * Get all subusers of this server
  * Defined in src/UserClient/Server.ts:386
```

--------------------------------

### ServerBuilder API Methods

Source: https://pterots.bothimtv.com/classes/ServerBuilder

Provides methods to configure server creation parameters. Each method typically sets a specific property and returns the ServerBuilder instance for method chaining.

```APIDOC
setDatabaseLimit(maxDatabases: number): ServerBuilder
  - Sets the maximum number of databases that can be created for this server.
  - Parameters:
    - maxDatabases: number - The maximum number of databases.
  - Returns: ServerBuilder - The ServerBuilder instance for chaining.
  - Default: 0
```

```APIDOC
setDescription(description: string): ServerBuilder
  - Sets the description for this server.
  - Parameters:
    - description: string - The server description.
  - Returns: ServerBuilder - The ServerBuilder instance for chaining.
```

```APIDOC
setDiskLimit(diskLimit: number): ServerBuilder
  - Sets the disk limit for this server in MiB.
  - Parameters:
    - diskLimit: number - The disk limit in MiB.
  - Returns: ServerBuilder - The ServerBuilder instance for chaining.
  - Default: 0
```

```APIDOC
setDockerImage(image: string): ServerBuilder
  - Sets the Docker image to be used when starting the server.
  - Parameters:
    - image: string - The Docker image name.
  - Returns: ServerBuilder - The ServerBuilder instance for chaining.
  - Default: Uses the default image if the egg is set via .setEgg(egg: PanelEgg).
```

```APIDOC
setEgg(egg: number | Egg): ServerBuilder
  - Sets the egg for this server. If not set as an ID, it also sets the Docker image, startup command, and variables to their defaults.
  - Parameters:
    - egg: number | Egg - The egg ID or the egg object.
  - Returns: ServerBuilder - The ServerBuilder instance for chaining.
```

```APIDOC
setEggId(egg: number): ServerBuilder
  - Manually sets the egg ID for the server.
  - Parameters:
    - egg: number - The egg ID.
  - Returns: ServerBuilder - The ServerBuilder instance for chaining.
```

```APIDOC
setEnvironment(environment: { [environment: string]: string }): ServerBuilder
  - Sets the environment variables with which the server will start.
  - Parameters:
    - environment: { [environment: string]: string } - An object where keys are environment variable names and values are their string representations.
  - Returns: ServerBuilder - The ServerBuilder instance for chaining.
  - Default: Uses the default environment if the egg is set via .setEgg(egg: PanelEgg).
```

```APIDOC
setFeatureLimits(limits: { allocations: number; backups: number; databases: number; }): ServerBuilder
  - Sets all feature limits for this server at once.
  - Parameters:
    - limits: object - An object containing the limits to set.
      - allocations: number - The limit for allocations.
      - backups: number - The limit for backups.
      - databases: number - The limit for databases.
  - Returns: ServerBuilder - The ServerBuilder instance for chaining.
```

```APIDOC
setIoLimit(ioLimit: number): ServerBuilder
  - [ADVANCED] Sets the IO limit for this server.
  - Documentation: <https://docs.docker.com/engine/reference/run/#block-io-bandwidth-blkio-constraint>
  - Parameters:
    - ioLimit: number - The IO limit value, expected to be between 10 and 1000.
  - Returns: ServerBuilder - The ServerBuilder instance for chaining.
  - Default: 0
```

--------------------------------

### APIDOC: Get Server Schedules

Source: https://pterots.bothimtv.com/classes/Server

Retrieves all schedules associated with a server. This method returns a promise that resolves to an array of Schedule objects.

```APIDOC
getSchedules(): Promise<[Schedule](Schedule.html)[]>
  * Get the schedules of this server
  * Defined in src/UserClient/Server.ts:327
```

--------------------------------

### Server Configuration and Details

Source: https://pterots.bothimtv.com/classes/Server

Methods for retrieving and updating various server configuration settings and details, such as description, Docker image, name, and server variables.

```APIDOC
setDescription(description: string): Promise<void>
  Updates the server's description.
  Parameters:
    description: The new description for the server.
  Returns: Promise<void>

setDockerImage(image: string): Promise<void>
  Updates the Docker image used by the server.
  Parameters:
    image: The new Docker image name (e.g., 'quay.io/pterodactyl/core:latest').
  Returns: Promise<void>

setName(name: string): Promise<void>
  Updates the server's display name.
  Parameters:
    name: The new name for the server.
  Returns: Promise<void>

getUsage(): Promise<Usage>
  Retrieves the current resource usage statistics for the server (CPU, memory, disk).
  Returns: Promise<Usage> object.

getVariables(): Promise<Array<Variable>>
  Fetches the server's configurable environment variables.
  Returns: Promise<Array<Variable>> where each Variable object contains name, description, and current value.
```

--------------------------------

### Script Configuration

Source: https://pterots.bothimtv.com/classes/Egg

Defines the script configuration for a Pterodactyl Egg, specifying container details, entry point, installation command, and privilege level.

```APIDOC
script:
  container: string
  entry: string
  extends?: null | string
  install: string
  privileged: boolean

Description: Configuration object for the egg's execution script.
- container: The Docker image to use for the script.
- entry: The entry point command or script within the container.
- extends: Optional. Specifies a parent script to extend.
- install: The command to run for installing dependencies.
- privileged: Whether the script requires elevated privileges.
```

--------------------------------

### APIDOC: Get Server Variables

Source: https://pterots.bothimtv.com/classes/Server

Retrieves all environment variables configured for the server. This method returns a promise that resolves to an array of Variable objects.

```APIDOC
getVariables(): Promise<[Variable](Variable.html)[]>
  * Get the variables of this server
  * Defined in src/UserClient/Server.ts:454
```

--------------------------------

### Server Class API

Source: https://pterots.bothimtv.com/classes/Server

Comprehensive API documentation for the Server class, covering its constructor, properties, and methods for interacting with game server functionalities.

```APIDOC
Server Class API Documentation

Implements: ServerAttributes
Defined in: src/UserClient/Server.ts:37

Constructors:

constructor(userClient: UserClient, server: RawServer): Server
  - Initializes a new Server instance.
  - Parameters:
    - userClient: The UserClient instance used for API requests.
    - server: The raw server data object.
  - Returns: A new Server instance.
  - Defined in: src/UserClient/Server.ts:79

Properties:

allocations?: Allocation[]
  - Optional. An array of Allocation objects associated with the server.
  - Defined in: src/UserClient/Server.ts:74

description: string
  - The description of the server.
  - Implementation of ServerAttributes.description.
  - Defined in: src/UserClient/Server.ts:49

docker_image: string
  - The Docker image used for the server.
  - Implementation of ServerAttributes.docker_image.
  - Defined in: src/UserClient/Server.ts:60

egg?: RawEgg
  - Optional. The raw Egg object associated with the server.
  - Defined in: src/UserClient/Server.ts:76

egg_features: string[]
  - Readonly. An array of features provided by the server's Egg.
  - Implementation of ServerAttributes.egg_features.
  - Defined in: src/UserClient/Server.ts:61

feature_limits: {
  allocations: number;
  backups: number;
  databases: number;
}
  - Readonly. An object detailing the limits for server features.
  - Implementation of ServerAttributes.feature_limits.
  - Defined in: src/UserClient/Server.ts:62

identifier: string
  - Readonly. The unique identifier for the server.
  - Implementation of ServerAttributes.identifier.
  - Defined in: src/UserClient/Server.ts:39

internal_id: string
  - The internal ID of the server.
  - Implementation of ServerAttributes.internal_id.
  - Defined in: src/UserClient/Server.ts:40

invocation: string
  - The command used to invoke the server process.
  - Implementation of ServerAttributes.invocation.
  - Defined in: src/UserClient/Server.ts:41

is_installing: boolean
  - Indicates if the server is currently installing.
  - Implementation of ServerAttributes.is_installing.
  - Defined in: src/UserClient/Server.ts:50

is_node_under_maintenance: boolean
  - Indicates if the node hosting the server is under maintenance.
  - Implementation of ServerAttributes.is_node_under_maintenance.
  - Defined in: src/UserClient/Server.ts:51

is_suspended: boolean
  - Indicates if the server is suspended.
  - Implementation of ServerAttributes.is_suspended.
  - Defined in: src/UserClient/Server.ts:52

is_transferring: boolean
  - Indicates if the server is currently transferring.
  - Implementation of ServerAttributes.is_transferring.
  - Defined in: src/UserClient/Server.ts:53

limits: {
  memory: number;
  swap: number;
  disk: number;
  io: number;
  cpu: number;
}
  - An object detailing the resource limits for the server.
  - Implementation of ServerAttributes.limits.
  - Defined in: src/UserClient/Server.ts:63

name: string
  - The name of the server.
  - Implementation of ServerAttributes.name.
  - Defined in: src/UserClient/Server.ts:42

node: string
  - The identifier of the node hosting the server.
  - Implementation of ServerAttributes.node.
  - Defined in: src/UserClient/Server.ts:43

server_owner: boolean
  - Indicates if the current user is the owner of the server.
  - Implementation of ServerAttributes.server_owner.
  - Defined in: src/UserClient/Server.ts:44

sftp_details: SFTPDetails
  - SFTP connection details for the server.
  - Implementation of ServerAttributes.sftp_details.
  - Defined in: src/UserClient/Server.ts:54

status: string
  - The current status of the server (e.g., 'running', 'stopped').
  - Implementation of ServerAttributes.status.
  - Defined in: src/UserClient/Server.ts:45

subusers?: Subuser[]
  - Optional. An array of Subuser objects associated with the server.
  - Defined in: src/UserClient/Server.ts:75

uuid: string
  - The UUID of the server.
  - Implementation of ServerAttributes.uuid.
  - Defined in: src/UserClient/Server.ts:38

variables?: Variable[]
  - Optional. An array of environment variables for the server.
  - Defined in: src/UserClient/Server.ts:77

Methods:

compressFiles(directory: string, exclude?: string[]): Promise<void>
  - Compresses files within a specified directory.
  - Parameters:
    - directory: The path to the directory to compress.
    - exclude: Optional. An array of file/directory patterns to exclude.
  - Returns: A Promise that resolves when compression is complete.
  - Defined in: src/UserClient/Server.ts:200

createAllocation(): Promise<Allocation>
  - Creates a new allocation for the server.
  - Returns: A Promise resolving with the newly created Allocation object.
  - Defined in: src/UserClient/Server.ts:130

createBackup(): Promise<Backup>
  - Creates a new backup for the server.
  - Returns: A Promise resolving with the newly created Backup object.
  - Defined in: src/UserClient/Server.ts:150

createDatabases(): Promise<Database>
  - Creates a new database for the server.
  - Returns: A Promise resolving with the newly created Database object.
  - Defined in: src/UserClient/Server.ts:160

createFolder(path: string): Promise<void>
  - Creates a new folder within the server's file system.
  - Parameters:
    - path: The path where the folder should be created.
  - Returns: A Promise that resolves when the folder is created.
  - Defined in: src/UserClient/Server.ts:205

createSchedule(): Promise<Schedule>
  - Creates a new schedule for the server.
  - Returns: A Promise resolving with the newly created Schedule object.
  - Defined in: src/UserClient/Server.ts:170

createSubuser(username: string, email: string, permissions: string[]): Promise<Subuser>
  - Creates a new subuser for the server.
  - Parameters:
    - username: The username for the new subuser.
    - email: The email address for the new subuser.
    - permissions: An array of permissions to grant to the subuser.
  - Returns: A Promise resolving with the newly created Subuser object.
  - Defined in: src/UserClient/Server.ts:180

decompressFile(file: string, destination?: string): Promise<void>
  - Decompresses a file within the server's file system.
  - Parameters:
    - file: The path to the file to decompress.
    - destination: Optional. The destination path for the decompressed files.
  - Returns: A Promise that resolves when decompression is complete.
  - Defined in: src/UserClient/Server.ts:210

deleteFiles(files: string[]): Promise<void>
  - Deletes specified files or directories from the server.
  - Parameters:
    - files: An array of paths to the files/directories to delete.
  - Returns: A Promise that resolves when deletion is complete.
  - Defined in: src/UserClient/Server.ts:215

getAllocations(): Promise<Allocation[]>
  - Fetches all allocations associated with the server.
  - Returns: A Promise resolving with an array of Allocation objects.
  - Defined in: src/UserClient/Server.ts:115

getBackup(backupId: string): Promise<Backup>
  - Fetches a specific backup for the server.
  - Parameters:
    - backupId: The ID of the backup to retrieve.
  - Returns: A Promise resolving with the Backup object.
  - Defined in: src/UserClient/Server.ts:145

getBackups(): Promise<Backup[]>
  - Fetches all backups for the server.
  - Returns: A Promise resolving with an array of Backup objects.
  - Defined in: src/UserClient/Server.ts:140

getConsoleSocket(): Promise<WebSocket>
  - Establishes a WebSocket connection for real-time console access.
  - Returns: A Promise resolving with the WebSocket connection.
  - Defined in: src/UserClient/Server.ts:190

getDatabases(): Promise<Database[]>
  - Fetches all databases associated with the server.
  - Returns: A Promise resolving with an array of Database objects.
  - Defined in: src/UserClient/Server.ts:155

getFiles(directory?: string): Promise<File[]>
  - Fetches files and directories within a specified directory.
  - Parameters:
    - directory: Optional. The directory path to list files from. Defaults to root.
  - Returns: A Promise resolving with an array of File objects.
  - Defined in: src/UserClient/Server.ts:195

getSchedule(scheduleId: string): Promise<Schedule>
  - Fetches a specific schedule for the server.
  - Parameters:
    - scheduleId: The ID of the schedule to retrieve.
  - Returns: A Promise resolving with the Schedule object.
  - Defined in: src/UserClient/Server.ts:165

getSchedules(): Promise<Schedule[]>
  - Fetches all schedules for the server.
  - Returns: A Promise resolving with an array of Schedule objects.
  - Defined in: src/UserClient/Server.ts:160

getStatus(): Promise<string>
  - Fetches the current status of the server.
  - Returns: A Promise resolving with the server's status string.
  - Defined in: src/UserClient/Server.ts:100

getSubuser(subuserId: string): Promise<Subuser>
  - Fetches a specific subuser for the server.
  - Parameters:
    - subuserId: The ID of the subuser to retrieve.
  - Returns: A Promise resolving with the Subuser object.
  - Defined in: src/UserClient/Server.ts:175

getSubusers(): Promise<Subuser[]>
  - Fetches all subusers associated with the server.
  - Returns: A Promise resolving with an array of Subuser objects.
  - Defined in: src/UserClient/Server.ts:170

getUsage(): Promise<Usage>
  - Fetches the resource usage statistics for the server.
  - Returns: A Promise resolving with the Usage object.
  - Defined in: src/UserClient/Server.ts:105

getVariables(): Promise<Variable[]>
  - Fetches the environment variables for the server.
  - Returns: A Promise resolving with an array of Variable objects.
  - Defined in: src/UserClient/Server.ts:185

kill(): Promise<void>
  - Sends a kill signal to the server process.
  - Returns: A Promise that resolves when the signal is sent.
  - Defined in: src/UserClient/Server.ts:230

reinstall(): Promise<void>
  - Reinstalls the server.
  - Returns: A Promise that resolves when the reinstall process is initiated.
  - Defined in: src/UserClient/Server.ts:240

renameFiles(from: string, to: string): Promise<void>
  - Renames a file or directory within the server's file system.
  - Parameters:
    - from: The current path of the file/directory.
    - to: The new path for the file/directory.
  - Returns: A Promise that resolves when the rename operation is complete.
  - Defined in: src/UserClient/Server.ts:220

restart(): Promise<void>
  - Restarts the server.
  - Returns: A Promise that resolves when the restart command is issued.
  - Defined in: src/UserClient/Server.ts:235

sendCommand(command: string): Promise<void>
  - Sends a command to the server's console.
  - Parameters:
    - command: The command string to send.
  - Returns: A Promise that resolves when the command is sent.
  - Defined in: src/UserClient/Server.ts:110

setDescription(description: string): Promise<void>
  - Updates the server's description.
  - Parameters:
    - description: The new description for the server.
  - Returns: A Promise that resolves when the description is updated.
  - Defined in: src/UserClient/Server.ts:250

setDockerImage(image: string): Promise<void>
  - Updates the server's Docker image.
  - Parameters:
    - image: The new Docker image to set.
  - Returns: A Promise that resolves when the Docker image is updated.
  - Defined in: src/UserClient/Server.ts:255

setName(name: string): Promise<void>
  - Updates the server's name.
  - Parameters:
    - name: The new name for the server.
  - Returns: A Promise that resolves when the name is updated.
  - Defined in: src/UserClient/Server.ts:260

start(): Promise<void>
  - Starts the server.
  - Returns: A Promise that resolves when the start command is issued.
  - Defined in: src/UserClient/Server.ts:225

stop(): Promise<void>
  - Stops the server.
  - Returns: A Promise that resolves when the stop command is issued.
  - Defined in: src/UserClient/Server.ts:245

uploadFile(file: File, destination: string): Promise<void>
  - Uploads a file to the server.
  - Parameters:
    - file: The File object to upload.
    - destination: The destination path on the server.
  - Returns: A Promise that resolves when the upload is complete.
  - Defined in: src/UserClient/Server.ts:265

uploadUrl(url: string, destination: string): Promise<void>
  - Uploads a file from a URL to the server.
  - Parameters:
    - url: The URL of the file to upload.
    - destination: The destination path on the server.
  - Returns: A Promise that resolves when the upload is complete.
  - Defined in: src/UserClient/Server.ts:270
```

--------------------------------

### Initialize ApplicationClient

Source: https://pterots.bothimtv.com/index

Demonstrates how to import and initialize the ApplicationClient for managing Pterodactyl resources. This client requires panel API keys with specific permissions.

```typescript
import { ApplicationClient } from 'pterodactyl.ts';
```

--------------------------------

### APIDOC: Get Specific Server Schedule

Source: https://pterots.bothimtv.com/classes/Server

Retrieves a specific schedule for a server by its ID. This method returns a promise that resolves to a single Schedule object.

```APIDOC
getSchedule(id: number): Promise<[Schedule](Schedule.html)>
  * Get the schedules of this server
  * Parameters:
    * id: number
  * Defined in src/UserClient/Server.ts:337
```

--------------------------------

### APIDOC: Get Server Resource Usage

Source: https://pterots.bothimtv.com/classes/Server

Fetches the current resource usage statistics for the server, such as CPU, memory, and disk. Returns a promise resolving to StatsAttributes.

```APIDOC
getUsage(): Promise<StatsAttributes>
  * Get the server resource usage
  * Defined in src/UserClient/Server.ts:125
```

--------------------------------

### PanelServer Reinstall Server

Source: https://pterots.bothimtv.com/classes/PanelServer

Reinstalls the server, typically resetting its configuration and files to a default state.

```APIDOC
reinstall(): Promise<void>
  Reinstall this server.

  Returns: Promise<void>
```

--------------------------------

### UserClient API Reference

Source: https://pterots.bothimtv.com/classes/UserClient

Comprehensive API documentation for the UserClient class, including its constructor, properties, and methods for interacting with the Pterodactyl API.

```APIDOC
Class UserClient

Hierarchy:
  BaseClient
    + UserClient

Defined in src/UserClient/UserClient.ts:9

Constructors:
  constructor(options: ClientOptions): UserClient
    Overrides BaseClient.constructor
    Parameters:
      options: ClientOptions
    Returns: UserClient
    Defined in src/UserClient/UserClient.ts:10

Properties:
  api: ((config: AxiosRequestConfig<any>, errorSet?: { code: number; message: string; }[], ignoredErrors?: string[]) => Promise<any>)
    Inherited from BaseClient.api
    Defined in src/BaseClient/BaseClient.ts:12
  
  apikey (Protected): string
    Inherited from BaseClient.apikey
    Defined in src/BaseClient/BaseClient.ts:10
  
  panel: string
    Inherited from BaseClient.panel
    Defined in src/BaseClient/BaseClient.ts:11

Methods:
  getAccount(): Promise<User>
    Get the account this api key is assigned to
    Returns: Promise<User>
    Defined in src/UserClient/UserClient.ts:17
  
  getServers(): Promise<Server[]>
    Get all Servers on this account
    Returns: Promise<Server[]>
    Defined in src/UserClient/UserClient.ts:25
  
  getServer(id: string): Promise<Server>
    Get a Server on this account
    Parameters:
      id: string
    Returns: Promise<Server>
    Defined in src/UserClient/UserClient.ts:33
  
  getServerUsage(id: string): Promise<StatsAttributes>
    Get the usage for a specific server
    Parameters:
      id: string
    Returns: Promise<StatsAttributes>
    Defined in src/UserClient/UserClient.ts:41
  
  getServerStatus(id: string): Promise<ServerStatus>
    Get the status of a specific server
    Parameters:
      id: string
    Returns: Promise<ServerStatus>
    Defined in src/UserClient/UserClient.ts:49
```

--------------------------------

### APIDOC: Get Specific Subuser

Source: https://pterots.bothimtv.com/classes/Server

Retrieves a specific subuser associated with the server using their unique identifier (UUID). Returns a promise resolving to a SubUser object.

```APIDOC
getSubuser(uuid: string): Promise<[SubUser](SubUser.html)>
  * Get a subuser of this server
  * Parameters:
    * uuid: string
  * Defined in src/UserClient/Server.ts:396
```

--------------------------------

### Create User with ApplicationClient

Source: https://pterots.bothimtv.com/index

Shows how to create a new user using the UserBuilder and ApplicationClient. It involves setting user details like email, name, username, and password.

```typescript
const newUser = new UserBuilder()
  .setEmail('mail@example.de')
  .setFirstName('Max')
  .setLastName('Mustermann')
  .setUsername('exampleGamer420')
  .setPassword(process.env.MAX_PASSWORD);

await applicationClient.createUser(newUser);
```

--------------------------------

### Create Allocations with ApplicationClient

Source: https://pterots.bothimtv.com/index

Demonstrates creating new server allocations using AllocationBuilder and ApplicationClient. This involves setting IP, alias, and adding ports for a node.

```typescript
const newAllocation = new AllocationBuilder()
  .setIp('1.2.3.4')
  .setAlias('example.com')
  .addPort(25565)
  .addPort('3000-3005')
  .addPorts([25566, 25567]);

await applicationClient.getNode(0).then((node) => {
  node.createAllocation(newAllocation);
});
```

--------------------------------

### Get User by ID - Pterodactyl API

Source: https://pterots.bothimtv.com/classes/ApplicationClient

Retrieves a single user from the Pterodactyl panel using their unique userId. Requires the user ID as a number. Returns a Promise resolving to a PanelUser object.

```APIDOC
getUser(userId: number): Promise<PanelUser>
  Get a user via their userId

  Parameters:
    userId: number
      The id of a user

  Returns: Promise<PanelUser>
```

--------------------------------

### Egg Class API Documentation

Source: https://pterots.bothimtv.com/classes/Egg

Provides a comprehensive overview of the Egg class, detailing its constructor signature, parameters, return types, and all defined properties with their types and descriptions.

```APIDOC
Class Egg

Implements:
* PanelEggAttributes

Defined in src/ApplicationClient/Egg.ts:18

Constructors:
* constructor(applicationClient: ApplicationClient, eggProps: RawPanelEgg): Egg
  Parameters:
    + applicationClient: ApplicationClient
    + eggProps: RawPanelEgg
  Returns: Egg
  Defined in src/ApplicationClient/Egg.ts:51

Properties:
* `Optional` associatedServers?: PanelServer[]
  Defined in src/ApplicationClient/Egg.ts:48
* `Optional` associatedVariables?: ServerVariable[]
  Defined in src/ApplicationClient/Egg.ts:49
* `Readonly` author: string
  Implementation of PanelEggAttributes.author
  Defined in src/ApplicationClient/Egg.ts:23
* `Readonly` config: {
    extends?: null | string;
    file_denylist: unknown[];
    files: {
      [key: string]: {
        find: {
          [key: string]: string;
        };
        parser: string;
      };
    };
    logs: unknown[];
    startup: {
      done: string;
      userInteraction: unknown[];
    };
    stop: string;
  }
  Implementation of PanelEggAttributes.config
  Defined in src/ApplicationClient/Egg.ts:27
* `Readonly` created_at: string | Date
  Implementation of PanelEggAttributes.created_at
  Defined in src/ApplicationClient/Egg.ts:45
* `Optional` description?: null | string
  Implementation of PanelEggAttributes.description
  Defined in src/ApplicationClient/Egg.ts:24
* docker_image: string
  Implementation of PanelEggAttributes.docker_image
  Defined in src/ApplicationClient/Egg.ts:25
* docker_images: {
    [key: string]: string;
  }
  Implementation of PanelEggAttributes.docker_images
  Defined in src/ApplicationClient/Egg.ts:26
* `Readonly` id: number
  Implementation of PanelEggAttributes.id
  Defined in src/ApplicationClient/Egg.ts:19
* `Readonly` name: string
  Implementation of PanelEggAttributes.name
  Defined in src/ApplicationClient/Egg.ts:21
* `Readonly` nest: number
  Implementation of PanelEggAttributes.nest
  Defined in src/ApplicationClient/Egg.ts:22
* `Optional` parentNest?: Nest
  Defined in src/ApplicationClient/Egg.ts:47
```

--------------------------------

### ServerSignalOption Type Alias

Source: https://pterots.bothimtv.com/types/ServerSignalOption

Defines the set of valid string signals that can be sent to a server, such as start, stop, restart, or kill. This type alias is used to ensure type safety when specifying server operations.

```TypeScript
ServerSignalOption:
    | "start"
    | "stop"
    | "restart"
    | "kill"
```

--------------------------------

### Get MFA Credentials (UserClient)

Source: https://pterots.bothimtv.com/classes/User

Retrieves the user's Multi-Factor Authentication (MFA) credentials, which include a data URL for an image (likely a QR code) and the secret key required for setting up authenticator apps.

```APIDOC
getMfaCredentials(): Promise<{
  image_url_data: string;
  secret: string;
}>
```

```TypeScript
/**
 * Get the users mfa/2fa credentials to generate the auth codes
 * @returns Promise<{ image_url_data: string; secret: string; }>
 */
getMfaCredentials(): Promise<{ image_url_data: string; secret: string; }>
```
Tokens:
Raw