pterodactyl.ts
    Preparing search index...

    Class PanelNode

    Implements

    • PanelNodeAttributes
    Index

    Constructors

    Properties

    allocated_resources: { disk: number; memory: number }
    allocations?: NodeAllocation[]
    behind_proxy: boolean
    created_at: Date
    daemon_base: string
    daemon_listen: number
    daemon_sftp: number
    description?: string | null
    disk: number
    disk_overallocate: number
    fqdn: string
    id: number
    location?: PanelLocation
    location_id: number
    maintenance_mode: boolean
    memory: number
    memory_overallocate: number
    name: string
    nodeConfiguration?: RawNodeConfiguration
    public: boolean
    scheme: "http" | "https"
    servers?: PanelServer[]
    updated_at: Date
    upload_size: number
    uuid: string

    Methods

    • 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>

    • Update weather this node is behind a proxy or not

      Parameters

      • behindProxy: boolean

        Is this node behind a proxy

      Returns Promise<void>

    • Update this nodes description

      Parameters

      • description: string

        The new description of this node

      Returns Promise<void>

    • Update this nodes disk

      Parameters

      • disk: number

        The new disk limit of this node (in MiB)

      Returns 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>

    • Update this nodes maintenance state

      Parameters

      • maintenanceActive: boolean

        Should this node be in maintenance mode

      Returns Promise<void>

    • Update this nodes memory

      Parameters

      • memory: number

        The new memory limit of this node (in MiB)

      Returns 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>

    • Update weather this node is public or not

      Parameters

      • isPublic: boolean

        Should this node be public

      Returns Promise<void>

    • Update this nodes scheme

      Parameters

      • scheme: "http" | "https"

        The new scheme of this node

      Returns 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>