Class PanelNode

constructor

• new PanelNode(applicationClient, nodeProps): PanelNode

• Parameters

  • applicationClient: ApplicationClient
  • nodeProps: RawPanelNode

  Returns PanelNode

Readonlyallocated_resources

Optionalallocations

behind_proxy

Readonlycreated_at

daemon_base

daemon_listen

daemon_sftp

Optionaldescription

disk

disk_overallocate

fqdn

Readonlyid

Optionallocation

location_id

maintenance_mode

memory

memory_overallocate

name

OptionalnodeConfiguration

public

scheme

Optionalservers

updated_at

upload_size

Readonlyuuid

createAllocation

• createAllocation(allocationProperties): Promise<void>

• Create a allocation for this node

  Parameters

  • allocationProperties: AllocationBuilder

  Returns Promise<void>

delete

• delete(): Promise<void>

• Delete this node

  Returns Promise<void>

getAllocations

• getAllocations(): Promise<NodeAllocation[]>

• Get the allocations of this node

  Returns Promise<NodeAllocation[]>

getConfiguration

• getConfiguration(): Promise<RawNodeConfiguration>

• Get the config of this node

  Returns Promise<RawNodeConfiguration>

resetDaemonMasterKey

• resetDaemonMasterKey(): Promise<void>

• Resets the Daemon Master Key
  This key is used for communication between the panel and the node(s)
  Pterodactyl suggests to rotate this secret regularly

  Returns Promise<void>

setBehindProxy

• setBehindProxy(behindProxy): Promise<void>

• Update weather this node is behind a proxy or not

  Parameters

  • behindProxy: boolean

    Is this node behind a proxy

  Returns Promise<void>

setDaemonPort

• setDaemonPort(port): Promise<void>

• Set the daemon port for this node

  ---

  If you use Cloudflare with the proxy feature, you'll need to use 8443
  More information: https://pterodactyl.io/wings/1.0/configuration.html#enabling-cloudflare-proxy

  Parameters

  • port: number

    The new port for the daemon

  Returns Promise<void>

  Default

  port 8080
  Copy

setDaemonSftpPort

• setDaemonSftpPort(port): Promise<void>

• Set the daemon sftp port for this node
  DO NOT use the same port as your servers SSH port!

  If you use Cloudflare with the proxy feature, you'll need to use the enterprise plan!
  More information: https://pterodactyl.io/wings/1.0/configuration.html#enabling-cloudflare-proxy

  Parameters

  • port: number

    The new port for the daemon sftp

  Returns Promise<void>

  Default

  port 2022
  Copy

setDescription

• setDescription(description): Promise<void>

• Update this nodes description

  Parameters

  • description: string

    The new description of this node

  Returns Promise<void>

setDisk

• setDisk(disk): Promise<void>

• Update this nodes disk

  Parameters

  • disk: number

    The new disk limit of this node (in MiB)

  Returns Promise<void>

setDiskOverAllocation

• setDiskOverAllocation(overAllocation): Promise<void>

• Set the disk overallocate for this node
  Use -1 to disable overallocation check
  Use 0 to prevent new servers if disk limit is reached

  Parameters

  • overAllocation: number

    in %

  Returns Promise<void>

setFqdn

• setFqdn(fqdn): Promise<void>

• Update this nodes fqdn

  Parameters

  • fqdn: string

    The new fqdn of this node

  Returns Promise<void>

setLocation

• setLocation(location): Promise<void>

• Update the location for this nodes

  Parameters

  • location: number | PanelLocation

    The new location of this node

  Returns Promise<void>

setMaintenance

• setMaintenance(maintenanceActive): Promise<void>

• Update this nodes maintenance state

  Parameters

  • maintenanceActive: boolean

    Should this node be in maintenance mode

  Returns Promise<void>

setMemory

• setMemory(memory): Promise<void>

• Update this nodes memory

  Parameters

  • memory: number

    The new memory limit of this node (in MiB)

  Returns Promise<void>

setMemoryOverAllocation

• setMemoryOverAllocation(overAllocation): Promise<void>

• Set the memory overallocate for this node
  Use -1 to disable overallocation check
  Use 0 to prevent new servers if memory limit is reached

  Parameters

  • overAllocation: number

    in %

  Returns Promise<void>

setName

• setName(name): Promise<void>

• Update this nodes name

  Parameters

  • name: string

    The new name of this node

  Returns Promise<void>

setPublic

• setPublic(isPublic): Promise<void>

• Update weather this node is public or not

  Parameters

  • isPublic: boolean

    Should this node be public

  Returns Promise<void>

setScheme

• setScheme(scheme): Promise<void>

• Update this nodes scheme

  Parameters

  • scheme: "http" | "https"

    The new scheme of this node

  Returns Promise<void>

setUploadSizeLimit

• setUploadSizeLimit(limit): Promise<void>

• Update this nodes upload size limit
  [Cloudflare allows 100 MiB on the free tier]

  Parameters

  • limit: number

    The new upload size limit of this node (in MiB)

  Returns Promise<void>