Api key to use
Fast login (No credential check)
If successful returns Successfully created!
const res = await app.createAllocation(1, ['25565']) // res = Successfully created!
app.createAllocation(1, ['25565'], 'minecraft').then((res) => console.log(res)) // res = Successfully created!
The node id of which you want to create allocations
Ports array to add
The alias for this allocation
IP for the allocation
Information about the new database
const res = await app.createDatabase('DATABASE_1', 1, 1) // res = DatabaseAttributes
app.createDatabase('DATABASE_1', 1, 1).then((res) => console.log(res)) // res = DatabaseAttributes
Name of the Database
ID of the Database Host
The server ID to create the database in
IP allowed to connect, leave "%" if you dont want to restrict
Optional options: DatabaseIncludeInputInclude information about server relationships
Location information
const res = await app.createLocation('Home') // res = LocationAttributes
app.createLocation('Home').then((res) => console.log(res)) // res = LocationAttributes
The short name of the new location
Optional description: stringThe description of location
Optional options: LocationIncludeInputInclude information about locations relationships
Information about the new node
const res = await app.createNode('NEW node', 'Good node', 1, 'node.gfd.com', 'https', 8192, 500000) // res = NodeAttributes
app.createNode('NEW node', 'Good node', 1, 'node.gfd.com', 'https', 8192, 500000).then((res) => console.log(res)) // res = NodeAttributes
The name of the node
A description for the node
Fully Qualified Domain Name (If you're using an IP scheme needs to be http)
Scheme to use: http or https
How much RAM should be allocated for the node?
How much disk space be allocated for the node?
Is this node public?
The daemon port (default 8080)
The daemon sftp port (default 2022)
Ram overallocation (default -1)
Disk overallocation (default -1)
Directory of the daemon, normally /var/lib/pterodactyl/volumes
Is the node in maintence mode?
Upload size (1-1024)
Is the node behind a proxy?
Optional options: NodeIncludeInputInclude information about relationships
Returns the created server object
const res = await app.createServer('BUNGEE', 1, 'BUNGEE SERVER', 1, 1) // res = ServerAttributes
app.createServer('BUNGEE', 1, 'BUNGEE SERVER', 1, 1).then((res) => console.log(res)) // res = ServerAttributes
Name of server to create
User ID of who should own this server
Description of server
ID of the nest to use when making a server
Egg ID to use when installing the server
Optional environment: ServerEnvironmentServers environment variables. Some are REQUIRED! If there is a default value and none is provided default is used!
Amount of cpu resources to give (1 core = 100) (0 unlimited)
Amount of memory resources to give (1024 = 1GB) (0 unlimited)
Amount of disk space to give (1024 = 1GB) (0 unlimited)
The max amount of databases a server can use
The max amount of allocation(s) a server can use
The max amount of backups a server can use
Optional startupCmd: stringThe command to use when starting this server
Optional dockerImage: stringThe image to use from Docker
The amount of Swap the server has
Set this to 500.
Optional options: ServerIncludesInputInclude information about server relationships
User information
const res = await app.createUser('linux123123', 'Linus', 'ADMIN', 'api@gmail.com') // res = UserAttributes
app.createUser('linux123123', 'Linus', 'ADMIN', 'api@gmail.com').then((res) => console.log(res)) // res = UserAttributes
The username of the user
The first name of the user
The last name of the user
The email address of the user
The password of the user
Is the user admin (default false)
The language of the user (default en)
Optional externalId: stringThe external id of user
If successful returns Successfully deleted!
const res = await app.deleteAllocation(1, 5) // res = Successfully deleted!
app.deleteAllocation(1, 8).then((res) => console.log(res)) // res = Successfully deleted!
The node id of which you want to delete allocation
The id of allocation to delete
If successful returns Successfully deleted the database!
const res = await app.resetDatabasePassword(1, 1) // res = Successfully deleted the database!
app.resetDatabasePassword(1, 2).then((res) => console.log(res)) // res = Successfully deleted the database!
The server ID to delete the database in
The ID of the database
Successfully deleted the location!
const res = await app.deleteLocation(1) // res = Successfully deleted the location!
app.deleteLocation(1).then((res) => console.log(res)) // res = Successfully deleted the location!
The location id to delete
If successful returns Successfully deleted!
const res = await app.deleteNode(1) // res = Successfully deleted!
app.deleteNode(1).then((res) => console.log(res)) // res = Successfully deleted!
The node id of which you want to get information
If successful returns Successfully deleted!
const res = await app.deleteServer(1) // res = Successfully deleted!
app.deleteServer(1, true).then((res) => console.log(res)) // res = Successfully deleted!
Internal ID of the server to delete
Boolean if forcefully delete a server
If successful returns Successfully deleted!
const res = await app.deleteUser(1) // res = Successfully deleted!
app.deleteUser(1).then((res) => console.log(res)) // res = Successfully deleted!
The user id of the user to delete
Location information
const res = await app.editLocation(1, 'Homie') // res = LocationAttributes
app.editLocation(1, undefined, 'Very good locaiton').then((res) => console.log(res)) // res = LocationAttributes
The location id to edit
Location edit options
Information about the new node
const res = await app.editNode('NEW node', 'Good node', 1, 'node.gfd.com', 'https', 8192, 500000) // res = NodeAttributes
app.editNode('NEW node', undefined, 1, 'node.gfd.com', undefined, 8192, 500000).then((res) => console.log(res)) // res = NodeAttributes
The node id of which you want to get information
Include information about relationships
Server information
const res = await app.editServerBuild(1, undefined, undefined, [5, 6]) // res = ServerAttributes
app.editServerBuild(1, undefined, [1, 3]).then((res) => console.log(res)) // res = ServerAttributes
The server ID to get the details of.
The options to edit
Server information
const res = await app.editServerDetails(1, 'Mc server') // res = ServerAttributes
app.editServerDetails(1, undefined, undefined, 'MC_SERVER').then((res) => console.log(res)) // res = ServerAttributes
The server ID to get the details of.
The options to edit
Server information
const res = await app.editServerStartup(1, 'node index.js') // res = ServerAttributes
app.editServerStartup(1, 'node index.js').then((res) => console.log(res)) // res = ServerAttributes
The external server ID to get the details of.
Include information about server relationships
User information
const res = await app.editUser(1, 'linux123123', undefined, 'ADMIN_LAST) // res = UserAttributes
app.editUser(1, undefined, 'Linux').then((res) => console.log(res)) // res = UserAttributes
The user id of the user to edit
Options to edit user
Private errorReturns information about node
const res = await app.getAllAllocations(1) // res = NodeAttributes
app.getAllAllocations(1).then((res) => console.log(res)) // res = NodeAttributes
The node id of which you want to get allocations from
Optional options: AllocationIncludeInputInclude information about relationships
Optional filter: AllocationFilterInputArray of locations
const res = await app.getAllLocations() // res = Location[]
app.getAllLocations().then((res) => console.log(res)) // res = Location[]
Optional options: LocationIncludeInputInclude information about locations relationships
Optional filter: LocationFilterInputFilter Location by specific fields and values
const res = await app.getAllNestEggs(1) // res = Egg[]
app.getAllNestEggs(1).then((res) => console.log(res)) // res = Egg[]
The nest ID to get the details of.
Optional options: EggIncludeInputInclude information about: nest or servers or variables
Array of nests
const res = await app.getAllNests() // res = Nest[]
app.getAllNests().then((res) => console.log(res)) // res = Nest[]
Optional options: NestIncludeInputInclude information about: eggs or servers
Array of nodes
const res = await app.getAllNodes() // res = Node[]
app.getAllNodes().then((res) => console.log(res)) // res = Node[]
Optional options: NodeIncludeInputInclude information about relationships
Optional filter: NodeFilterInputFilter Nodes by specific fields and values
Array of server
const res = await app.getAllServers() // res = Server[]
app.getAllServers().then((res) => console.log(res)) // res = Server[]
Optional options: ServerIncludesInputInclude information about server relationships
Optional filter: ServerFilterInputFilter Servers by specific fields and values
Array of users
const res = await app.getAllUsers() // res = User[]
app.getAllUsers().then((res) => console.log(res)) // res = User[]
Optional options: UserIncludeInputInclude information about relationships
Optional filter: UserFilterInputFilter Users by specific fields and values
const res = await app.getEggInfo(1, 1) // res = EggAttributes
app.getEggInfo(1, 1).then((res) => console.log(res)) // res = EggAttributes
Egg ID to use when installing the server
Optional options: EggIncludeInputInclude information about: nest or servers or variables
Location information
const res = await app.getLocationInfo(1) // res = LocationAttributes
app.getLocationInfo(1).then((res) => console.log(res)) // res = LocationAttributes
The location id to get information about
Optional options: LocationIncludeInputInclude information about locations relationships
Nest details
const res = await app.getNestInfo(1) // res = NestAttributes
app.getNestInfo(1).then((res) => console.log(res)) // res = NestAttributes
The nest ID to get the details of.
Optional options: NestIncludeInputInclude information about: eggs or servers
Returns information about node config
const res = await app.getNodeConfig(1) // res = NodeConfig
app.getNodeConfig(1).then((res) => console.log(res)) // res = NodeConfig
The node id of which you want to get information
Returns information about node
const res = await app.getNodeInfo(1) // res = NodeAttributes
app.getNodeInfo(1).then((res) => console.log(res)) // res = NodeAttributes
The node id of which you want to get information
Optional options: NodeIncludeInputInclude information about relationships
Server information
const res = await app.getServerInfo(1) // res = ServerAttributes
app.getServerInfo(1).then((res) => console.log(res)) // res = ServerAttributes
The server ID to get the details of.
Optional options: ServerIncludesInputInclude information about server relationships
Server information
const res = await app.getServerInfoByExtId('MC_SERVER') // res = ServerAttributes
app.getServerInfoByExtId('GAMER_SERVER').then((res) => console.log(res)) // res = ServerAttributes
The external server ID to get the details of.
Optional options: ServerIncludesInputInclude information about server relationships
Database information
const res = await app.getServersDatabaseInfo(1, 1) // res = DatabaseAttributes
app.getServersDatabaseInfo(1, 2).then((res) => console.log(res)) // res = DatabaseAttributes
The server ID to get the database from
The ID of the database
Optional options: DatabaseIncludeInputInclude information about server relationships
Array of databases
const res = await app.getServersDatabase(1) // res = Database[]
app.getServersDatabase(1).then((res) => console.log(res)) // res = Database[]
The server ID to get the databases from
Optional options: DatabaseIncludeInputInclude information about server relationships
User information
const res = await app.getUserInfo(1) // res = UserAttributes
app.getUserInfo(1).then((res) => console.log(res)) // res = UserAttributes
The user id to get information about
Optional options: UserIncludeInputInclude information about relationships
Private hostPanels address
Private keyApi key to use
If successful returns Successfully reinstalled!
const res = await app.reinstallServer(1) // res = Successfully reinstalled!
app.reinstallServer(1).then((res) => console.log(res)) // res = Successfully reinstalled!
If successful returns Successfully reset the password!
const res = await app.resetDatabasePassword(1, 1) // res = Successfully reset the password!
app.resetDatabasePassword(1, 2).then((res) => console.log(res)) // res = Successfully reset the password!
The server ID to get the database from
The ID of the database
If successful returns Successfully suspended!
const res = await app.suspendServer(1) // res = Successfully suspended!
app.suspendServer(1).then((res) => console.log(res)) // res = Successfully suspended!
If successful returns Successfully unsuspended!
const res = await app.unSuspendServer(1) // res = Successfully unsuspended!
app.unSuspendServer(1).then((res) => console.log(res)) // res = Successfully unsuspended!
Generated using TypeDoc
Panels address