Class ClientApi

Pterodactyl Panel Client API A comprehensive TypeScript client for interacting with the Pterodactyl Panel API

Author

vspcoder

Constructors

constructor

new ClientApi(
    panelUrl: string,
    clientKey: string,
    options?: ClientApiOptions,
): ClientApi
Parameters
- panelUrl: string
- clientKey: string
- options: ClientApiOptions = {}
Returns ClientApi
- Defined in index.ts:1823

Methods

assignAllocation

assignAllocation(serverId: string): Promise<AutoGeneratedAllocation>
Parameters
- serverId: string
Returns Promise<AutoGeneratedAllocation>
- Defined in index.ts:2243

compressFiles

compressFiles(serverId: string, root: string, files: string[]): Promise<void>
Parameters
- serverId: string
- root: string
- files: string[]
Returns Promise<void>
- Defined in index.ts:2092

copyFile

copyFile(serverId: string, filePath: string): Promise<void>
Parameters
- serverId: string
- filePath: string
Returns Promise<void>
- Defined in index.ts:2084

createAPIKey

createAPIKey(description: string, allowedIPs?: string[]): Promise<CreatedAPIKey>
Parameters
- description: string
- OptionalallowedIPs: string[]
Returns Promise<CreatedAPIKey>
- Defined in index.ts:1963

createBackup

createBackup(serverId: string, name?: string, ignored?: string[]): Promise<void>
Parameters
- serverId: string
- Optionalname: string
- Optionalignored: string[]
Returns Promise<void>
- Defined in index.ts:2309

createDatabase

createDatabase(
    serverId: string,
    database: string,
    remote: string,
): Promise<CreatedDatabase>
Parameters
- serverId: string
- database: string
- remote: string
Returns Promise<CreatedDatabase>
- Defined in index.ts:2016

createFolder

createFolder(serverId: string, root: string, name: string): Promise<void>
Parameters
- serverId: string
- root: string
- name: string
Returns Promise<void>
- Defined in index.ts:2116

createSchedule

createSchedule(
    serverId: string,
    name: string,
    cron: {
        dayOfMonth: string;
        dayOfWeek: string;
        hour: string;
        minute: string;
    },
    isActive?: boolean,
): Promise<void>
Parameters
- serverId: string
- name: string
- cron: { dayOfMonth: string; dayOfWeek: string; hour: string; minute: string }
- isActive: boolean = true
Returns Promise<void>
- Defined in index.ts:2140

createTask

createTask(
    serverId: string,
    scheduleId: string,
    action: "backup" | "command" | "power",
    payload: string,
    timeOffset: number,
): Promise<void>
Parameters
- serverId: string
- scheduleId: string
- action: "backup" | "command" | "power"
- payload: string
- timeOffset: number
Returns Promise<void>
- Defined in index.ts:2201

createUser

createUser(
    serverId: string,
    email: string,
    permissions: string[],
): Promise<void>
Parameters
- serverId: string
- email: string
- permissions: string[]
Returns Promise<void>
- Defined in index.ts:2280

decompressFile

decompressFile(serverId: string, root: string, file: string): Promise<void>
Parameters
- serverId: string
- root: string
- file: string
Returns Promise<void>
- Defined in index.ts:2100

deleteAPIKey

deleteAPIKey(identifier: string): Promise<void>
Parameters
- identifier: string
Returns Promise<void>
- Defined in index.ts:1974

deleteBackup

deleteBackup(serverId: string, backupUuid: string): Promise<void>
Parameters
- serverId: string
- backupUuid: string
Returns Promise<void>
- Defined in index.ts:2325

deleteDatabase

deleteDatabase(serverId: string, databaseId: string): Promise<void>
Parameters
- serverId: string
- databaseId: string
Returns Promise<void>
- Defined in index.ts:2039

deleteFiles

deleteFiles(serverId: string, root: string, files: string[]): Promise<void>
Parameters
- serverId: string
- root: string
- files: string[]
Returns Promise<void>
- Defined in index.ts:2108

deleteSchedule

deleteSchedule(serverId: string, scheduleId: string): Promise<void>
Parameters
- serverId: string
- scheduleId: string
Returns Promise<void>
- Defined in index.ts:2196

deleteTask

deleteTask(serverId: string, scheduleId: string, taskId: string): Promise<void>
Parameters
- serverId: string
- scheduleId: string
- taskId: string
Returns Promise<void>
- Defined in index.ts:2230

deleteUser

deleteUser(serverId: string, subuserUuid: string): Promise<void>
Parameters
- serverId: string
- subuserUuid: string
Returns Promise<void>
- Defined in index.ts:2300

disableTwoFA

disableTwoFA(password: string): Promise<DisableTwoFA>
Parameters
- password: string
Returns Promise<DisableTwoFA>
- Defined in index.ts:1930

downloadFile

downloadFile(serverId: string, filePath: string): Promise<string>
Parameters
- serverId: string
- filePath: string
Returns Promise<string>
- Defined in index.ts:2128

enableTwoFA

enableTwoFA(code: number): Promise<EnableTwoFA>
Parameters
- code: number
Returns Promise<EnableTwoFA>
- Defined in index.ts:1922

generateDatabasePassword

generateDatabasePassword(
serverId: string,
databaseId: string,
): Promise<GeneratedPassDatabase>
Parameters
- serverId: string
- databaseId: string
Returns Promise<GeneratedPassDatabase>
- Defined in index.ts:2028

generateUploadURL

generateUploadURL(serverId: string): Promise<GeneratedUploadURL>
Parameters
- serverId: string
Returns Promise<GeneratedUploadURL>
- Defined in index.ts:2124

getBackupDetails

getBackupDetails(serverId: string, backupUuid: string): Promise<Backup>
Parameters
- serverId: string
- backupUuid: string
Returns Promise<Backup>
- Defined in index.ts:2317

getBackupDownloadLink

getBackupDownloadLink(
serverId: string,
backupUuid: string,
): Promise<{ attributes: { url: string }; object: string }>
Parameters
- serverId: string
- backupUuid: string
Returns Promise<{ attributes: { url: string }; object: string }>
- Defined in index.ts:2321

getScheduleDetails

getScheduleDetails(
serverId: string,
scheduleId: string,
): Promise<SchedulesDetails>
Parameters
- serverId: string
- scheduleId: string
Returns Promise<SchedulesDetails>
- Defined in index.ts:2165

getServerDetails

getServerDetails(serverId: string): Promise<ServerDetails>
Parameters
- serverId: string
Returns Promise<ServerDetails>
- Defined in index.ts:1991

getSubUserDetails

getSubUserDetails(serverId: string, subuserUuid: string): Promise<ServerSubuser>
Parameters
- serverId: string
- subuserUuid: string
Returns Promise<ServerSubuser>
- Defined in index.ts:2288

getTwoFAQRCode

getTwoFAQRCode(): Promise<TwoFAQRcode>
Returns Promise<TwoFAQRcode>
- Defined in index.ts:1918

getUserDetails

getUserDetails(): Promise<UserDetails>
Returns Promise<UserDetails>
- Defined in index.ts:1914

listAllocations

listAllocations(serverId: string): Promise<AllocationsList>
Parameters
- serverId: string
Returns Promise<AllocationsList>
- Defined in index.ts:2239

listAPIKeys

listAPIKeys(): Promise<ListAPIKeys>
Returns Promise<ListAPIKeys>
- Defined in index.ts:1959

listBackups

listBackups(serverId: string): Promise<BackupsList>
Parameters
- serverId: string
Returns Promise<BackupsList>
- Defined in index.ts:2305

listDatabases

listDatabases(serverId: string): Promise<DatabaseList>
Parameters
- serverId: string
Returns Promise<DatabaseList>
- Defined in index.ts:2012

listFiles

listFiles(serverId: string, directory?: string): Promise<FilesList>
Parameters
- serverId: string
- Optionaldirectory: string
Returns Promise<FilesList>
- Defined in index.ts:2048

listSchedules

listSchedules(serverId: string): Promise<SchedulesList>
Parameters
- serverId: string
Returns Promise<SchedulesList>
- Defined in index.ts:2136

listServers

listServers(
options?: { includeEgg?: boolean; includeSubusers?: boolean },
): Promise<ServersList>
Parameters
- Optionaloptions: { includeEgg?: boolean; includeSubusers?: boolean }
Returns Promise<ServersList>
- Defined in index.ts:1979

listStartupVariables

listStartupVariables(serverId: string): Promise<any>
Parameters
- serverId: string
Returns Promise<any>
- Defined in index.ts:2330

listUsers

listUsers(serverId: string): Promise<UsersList>
Parameters
- serverId: string
Returns Promise<UsersList>
- Defined in index.ts:2276

readFileContents

readFileContents(serverId: string, filePath: string): Promise<string>
Parameters
- serverId: string
- filePath: string
Returns Promise<string>
- Defined in index.ts:2053

reinstallServer

reinstallServer(serverId: string): Promise<void>
Parameters
- serverId: string
Returns Promise<void>
- Defined in index.ts:2003

renameFile

renameFile(
    serverId: string,
    root: string,
    from: string,
    to: string,
): Promise<void>
Parameters
- serverId: string
- root: string
- from: string
- to: string
Returns Promise<void>
- Defined in index.ts:2068

renameServer

renameServer(serverId: string, newName: string): Promise<void>
Parameters
- serverId: string
- newName: string
Returns Promise<void>
- Defined in index.ts:1995

setAllocationNote

setAllocationNote(
    serverId: string,
    allocationId: number,
    notes: string,
): Promise<void>
Parameters
- serverId: string
- allocationId: number
- notes: string
Returns Promise<void>
- Defined in index.ts:2251

setPrimaryAllocation

setPrimaryAllocation(serverId: string, allocationId: number): Promise<void>
Parameters
- serverId: string
- allocationId: number
Returns Promise<void>
- Defined in index.ts:2259

unassignAllocation

unassignAllocation(serverId: string, allocationId: number): Promise<void>
Parameters
- serverId: string
- allocationId: number
Returns Promise<void>
- Defined in index.ts:2267

updateEmail

updateEmail(newEmail: string, password: string): Promise<void>
Parameters
- newEmail: string
- password: string
Returns Promise<void>
- Defined in index.ts:1938

updatePassword

updatePassword(currentPassword: string, newPassword: string): Promise<void>
Parameters
- currentPassword: string
- newPassword: string
Returns Promise<void>
- Defined in index.ts:1946

updateSchedule

updateSchedule(
    serverId: string,
    scheduleId: string,
    name: string,
    cron: {
        dayOfMonth: string;
        dayOfWeek: string;
        hour: string;
        minute: string;
    },
    isActive?: boolean,
): Promise<void>
Parameters
- serverId: string
- scheduleId: string
- name: string
- cron: { dayOfMonth: string; dayOfWeek: string; hour: string; minute: string }
- OptionalisActive: boolean
Returns Promise<void>
- Defined in index.ts:2169

updateStartupVariable

updateStartupVariable(
    serverId: string,
    key: string,
    value: string,
): Promise<void>
Parameters
- serverId: string
- key: string
- value: string
Returns Promise<void>
- Defined in index.ts:2334

updateTask

updateTask(
    serverId: string,
    scheduleId: string,
    taskId: string,
    action: "backup" | "command" | "power",
    payload: string,
    timeOffset: number,
): Promise<void>
Parameters
- serverId: string
- scheduleId: string
- taskId: string
- action: "backup" | "command" | "power"
- payload: string
- timeOffset: number
Returns Promise<void>
- Defined in index.ts:2215

updateUser

updateUser(
    serverId: string,
    subuserUuid: string,
    permissions: string[],
): Promise<void>
Parameters
- serverId: string
- subuserUuid: string
- permissions: string[]
Returns Promise<void>
- Defined in index.ts:2292

writeFile

writeFile(serverId: string, filePath: string, content: string): Promise<void>
Parameters
- serverId: string
- filePath: string
- content: string
Returns Promise<void>
- Defined in index.ts:2060

Class ClientApi

Author

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ClientApi

Methods

assignAllocation

Parameters

Returns Promise<AutoGeneratedAllocation>

compressFiles

Parameters

Returns Promise<void>

copyFile

Parameters

Returns Promise<void>

createAPIKey

Parameters

Returns Promise<CreatedAPIKey>

createBackup

Parameters

Returns Promise<void>

createDatabase

Parameters

Returns Promise<CreatedDatabase>

createFolder

Parameters

Returns Promise<void>

createSchedule

Parameters

Returns Promise<void>

createTask

Parameters

Returns Promise<void>

createUser

Parameters

Returns Promise<void>

decompressFile

Parameters

Returns Promise<void>

deleteAPIKey

Parameters

Returns Promise<void>

deleteBackup

Parameters

Returns Promise<void>

deleteDatabase

Parameters

Returns Promise<void>

deleteFiles

Parameters

Returns Promise<void>

deleteSchedule

Parameters

Returns Promise<void>

deleteTask

Parameters

Returns Promise<void>

deleteUser

Parameters

Returns Promise<void>

disableTwoFA

Parameters

Returns Promise<DisableTwoFA>

downloadFile

Parameters

Returns Promise<string>

enableTwoFA

Parameters

Returns Promise<EnableTwoFA>

generateDatabasePassword

Parameters

Returns Promise<GeneratedPassDatabase>

generateUploadURL

Parameters

Returns Promise<GeneratedUploadURL>

getBackupDetails