Skip to main content
Module

x/ptereno/lib/types/application.ts>NewServerOptions

An efficient and fully compliant Pterodactyl API wrapper.
Alanexei/Ptereno
Latest
interface NewServerOptions
import { type NewServerOptions } from "https://deno.land/x/ptereno@v1.0.1/lib/types/application.ts";

Properties

name: string

The server name

user: number

The owner user id

optional
description: string

The server description

optional
start: boolean

When enabled, the server will start on creation.

optional
node: number

The server node id

allocation: number

The server default allocation id

optional
additionalAllocations: Array<number>

A list of allocation ids to assign to the server.

The allocations must not already be assigned to a server.

optional
featureLimits: { databases?: number; allocation?: number; backups?: number; }
limits: { cpu?: number; threads?: string; memory: number; swap?: number; disk: number; io?: number; }

The server limits

egg: number

The server egg id

optional
skipScripts: boolean

When enabled, the install script will not be ran during installation.

image: string

The URL for the docker image.

startup: string

The startup command used by the server.

environment: Record<string, string>

The key-pair value representing the environment variables.

All environment variables and their respective values must be included.