Options
All
  • Public
  • Public/Protected
  • All
Menu

The base class for the Pterodactyl application API. This operates using a Pterodactyl API key which can be found at <your.domain.name/admin/api> or <your.domain.name/account/api> if you are using a client API key.

Warning: Keep your API key private at all times. Exposing this can lead to your servers, nodes, configurations and more being corrupted and/or deleted.

Hierarchy

  • PteroApp

Index

Constructors

  • new PteroApp(domain: string, auth: string, options?: Record<string, OptionSpec>): PteroApp

Properties

auth: string

The API key for your Pterodactyl panel. This should be kept private at all times. Full access must be granted in the panel for the whole library to be accessible.

domain: string

The domain for your Pterodactyl panel. This should be the main URL only (not "/api"). Any additional paths will count as the API path.

options: Record<string, OptionSpec>
deprecated

To be replaced with a better system.

requests: RequestManager

Accessors

  • get ping(): number

Generated using TypeDoc