PteroClient class abstract

Pterodactyl API Client

Available Extensions

• ClientUtility
• ParseSiteConfig
• PteroClientStuff
• PteroClientVisibleDio

Annotations

• @RestApi()

Constructors

PteroClient(Dio dio, {String? baseUrl})

Creates an instance of the PteroClient class.

factory

PteroClient.generate({required String url, String? apiKey, Dio? dio, String userAgent = 'Dartactyl/v1', bool addDefaultInterceptors = true})

Set up a Pterodactyl API Client in one go! baseUrl is the base URL of the Pterodactyl server. apiKey is the API key of the Pterodactyl account. leave apiKey blank if you'd rather use cookies with user/pass.

factory

PteroClient.mockApi([Dio? dio])

Creates an instance of the PteroClient class.

factory

Properties

baseUrl → String?

The base URL of the Pterodactyl server.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

autoAssignAllocation({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<Allocation>>

Automatically assign an allocation on the Server

chmodFile(ChmodFileBody data, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Changes the permissions of a file or folder on the Server

compressFile(FileBodyListString data, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<FileObject>>

Compress a file into an archive (eg. zip) on the Server

createApiKey(CreateApiKey data, {CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalDataMeta<ApiKey, ApiKeyMeta>>

Create a new ApiKey on your account. This is the only time you will ever get the full key.

createBackup(CreateBackup backupData, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<Backup>>

Create a backup on the Server

createFolder(FolderBody data, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Creates the specified folder in the specified directory

createSchedule(RequestSchedule scheduleData, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ServerSchedule>>

Create a ServerSchedule on the Server

createServerDatabase(CreateServerDatabase data, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ServerDatabase>>

Create a new database on the server

createSshKey(CreateSshKey data, {CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<SshKey>>

Create a new SshKey on your account.

createSubuser(Subuser subuserData, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ServerSubuser>>

Create ServerSubuser on the Server

createTask(Task taskData, {required String serverId, required int scheduleId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ScheduleTask>>

Create a scheduled Task on a ServerSchedule

decompressFile(FileBody data, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Decompress an archive (eg. zip) on the Server

deleteApiKey({required String apiKeyId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Delete an ApiKey on your account.

deleteBackup({required String serverId, required String backupId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Delete a Backup from the Server

deleteDatabase({required String serverId, required String databaseId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Delete a ServerDatabase

deleteFiles(FileBodyListString data, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Delete one or more files on the Server

deleteSchedule({required String serverId, required int scheduleId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Delete a ServerSchedule from the Server

deleteSshKey(DeleteSSHKey body, {CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Delete an SshKey on your account. (1.9+)

deleteSubuser({required String serverId, required String subuserId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Delete a ServerSubuser from the Server

deleteTask({required String serverId, required int scheduleId, required int taskId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Delete a scheduled Task on a ServerSchedule

disableTwoFactor(DisableTwoFactor data, {CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Disable two factor authentication.

enableTwoFactor(TwoFactorCode code, {CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<RecoveryTokens>>

Enable two factor authentication.

getAccountActivity({ActivityLogsIncludes? include, int? page, int? perPage, ActivityFilters? filters, ActivityLogSort? sort, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListMeta<ActivityLog, PaginatedMeta>>

Get your Account activity.

getAccountInfo({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<Account>>

Get account information.

getBackupDetails({required String serverId, required String backupId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<Backup>>

Get information about a Backup from the Server

getBackupDownloadUrl({required String serverId, required String backupId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<SignedUrl>>

Generate download url for a Backup from the Server

getFileContents({required String serverId, required String file, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<String?>

Get a file's contents from the Server

getFileDownloadUrl({required String serverId, required String file, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<SignedUrl>>

Download a file from the Server

getFileUploadUrl({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<SignedUrl>>

Returns a SignedUrl used to upload files to the Server using POST

getScheduleDetails({required String serverId, required int scheduleId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ServerSchedule>>

Get a ServerSchedule's details from the Server

getServerActivity({required String serverId, ActivityLogsIncludes? include, int? page, int? perPage, ActivityFilters? filters, ActivityLogSort? sort, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListMeta<ActivityLog, PaginatedMeta>>

Get the Server activity.

getServerDetails({required String serverId, ServerIncludes? include, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalDataMeta<Server, ServerMeta>>

Get a server's information.

getServerResources({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<Stats>>

Get the Server's current Stats.

getServerWebsocket({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<PteroData<WebsocketDetails>>

Get the Server's WebsocketDetails.

getStartup({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListMeta<EggVariable, StartupMeta>>

Alias of listVariables

getSubuserDetails({required String serverId, required String subuserId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ServerSubuser>>

Get a ServerSubuser's details on the Server

getSystemPermissions({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<SystemPermissions>>

Get system permissions

getTwoFactor({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<TwoFactorImage>>

Get two factor authentication image.

listAllocations({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListData<Allocation>>

List all allocations that the Server has

listApiKeys({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListData<ApiKey>>

Get all current ApiKeys on your account. Keys are shortened to the first x characters.

listBackups({required String serverId, int? page, int? perPage, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListMeta<Backup, PaginatedBackupsMeta>>

List all backups on the Server

listDockerImages({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Map<String, String>>

List all docker images for a server.

listFiles({required String serverId, required String directory, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListData<FileObject>>

List all files on the Server

listSchedules({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListData<ServerSchedule>>

List all schedules that the Server has

listServerDatabases({required String serverId, ServerDatabasesIncludes? include, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListData<ServerDatabase>>

List all databases that are available to the server

listServers({int? page = 1, int? perPage = 50, ServerIncludes? include, ServerFilters? filters, GetServersQueryType? type = GetServersQueryType.member, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListMeta<Server, PaginatedMeta>>

Get a list of servers.

listSshKeys({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListData<SshKey>>

List all SshKeys on your account.

listSubusers({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListData<ServerSubuser>>

List all ServerSubusers on the Server

listVariables({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalListMeta<EggVariable, StartupMeta>>

Get all Server startup variables Includes egg docker images, startup script, and the raw startup script

makeFileCopy(MakeFileCopy data, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Make a copy of a file on the Server

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pullFile(PullFileBody data, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Download a file from a remote url to the Server directly

reinstallServer({required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Reinstall the Server

renameFile(FileBodyListFromTo rename, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Rename a file on the Server

renameServer(Rename rename, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Rename the Server

restoreBackup(RestoreBackup body, {required String serverId, required String backupId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Restore a Backup to the Server

rotateDatabasePassword({required String serverId, required String databaseId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ServerDatabase>>

TODO: on rotateDatabasePassword

sendServerCommand(SendServerCommand data, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Send a command to the Server.

sendServerPowerAction(Signal signal, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

send a Power Signal to the Server.

setAllocationNote(AllocationNote note, {required String serverId, required int allocationId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<Allocation>>

Set the allocation note for an Allocation on the Server

setPrimaryAllocation({required String serverId, required int allocationId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<Allocation>>

Set an Allocation as the primary allocation on Server

toggleBackupLock({required String serverId, required String backupId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<Backup>>

Lock a Backup to protect it from automated or accidental deletions

toString() → String

A string representation of this object.

inherited

unassignAllocation({required String serverId, required int allocationId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<Allocation>>

Unassign an Allocation from Server

updateDockerImage(UpdateImage dockerImage, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Update the Server docker image to dockerImage

updateEmail(UpdateEmail data, {CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Update your Account account email address.

updatePassword(UpdatePassword data, {CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Update your Account account password.

updateSchedule(RequestSchedule scheduleData, {required String serverId, required int scheduleId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ServerSchedule>>

Update a ServerSchedule on the Server

updateSubuser(SubuserPermissions subuserData, {required String serverId, required String subuserId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ServerSubuser>>

Update a ServerSubuser on the Server

updateTask(Task taskData, {required String serverId, required int scheduleId, required int taskId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<ScheduleTask>>

Update a scheduled Task on a ServerSchedule

updateVariable(KeyValue variable, {required String serverId, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<FractalData<EggVariable>>

Update the Server startup variable with the contents of variable

writeFile(String rawContents, {required String serverId, required String file, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<void>

Write a file to the Server

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

defaultInterceptors → List<Interceptor>

A list of interceptors that are added by default with PteroClient.generate.

final