dartactyl_visible_dio library
Classes
- Account
- ActivityFilters
- ActivityLog
- ActivityLogRelationships
- ActivityLogsIncludes
- ActivityLogSort
- Allocation
- AllocationIncludes
- AllocationNote
- AllocationPermissionKeys
- ApiKey
- ApiKeyMeta
-
Shows on
createApiKey - ApplicationAllocation
- ApplicationServer
- ApplicationServerContainer
- ApplicationServerIncludes
- ApplicationServerRelationships
- ApplicationUser
- ApplicationUserRelationships
- ApplicationUsersIncludes
- Backup
- BackupPermissionKeys
- CancelToken
-
Controls cancellation of
Dio's requests. - ChmodFile
- ChmodFileBody
- ControlPermissionKeys
- CreateApiKey
- CreateBackup
- CreateNodeRequest
- CreateServerDatabase
- CreateSshKey
- CreateUserRequest
- Cron
- Database
- DatabasePassword
- DatabasePasswordRelationships
- DatabasePermissionKeys
- Databases
- DeleteSSHKey
- DeprecatedPteroClient
- A client for deprecated Pterodactyl APIs.
- DisableTwoFactor
- Egg
- EggConfig
- EggLogsConfig
- EggScript
- EggStartupConfig
- EggVariable
- FileBody
- FileBodyListFromTo
- FileBodyListString
- FileObject
-
nameis the name of the file. - FilePermissionKeys
-
Filters<
E extends FilterEnumMixin> - FolderBody
-
Fractal<
T extends Object> - A mixin for FractalData and FractalMeta
-
FractalData<
T extends Object> -
FractalList<
T extends Object> - A mixin for FractalListData and FractalListMeta
-
FractalListData<
T extends Object> -
FractalListMeta<
T extends Object, M extends Meta> -
FractalMeta<
T extends Object, M extends Meta> - FromTo
- HandleErrorInterceptor
- Includes
- Consider using specific subtypes like ServerIncludes, ActivityLogsIncludes, ScheduleIncludes, and ServerDatabasesIncludes. These expose the options available for those routes directly
- KeyValue
- Links
- Location
- MakeFileCopy
- Meta
- Nest
- Node
- NodeIncludes
- NodeRelationships
- NodesSort
- PaginatedBackupsMeta
-
Shows on
listBackups - PaginatedMeta
-
Shows on
listServers - Pagination
- Permissions
-
PermissionsModel<
T extends Object> - PteroApplication
- Pterodactyl Application API Client
- PteroClient
- Pterodactyl API Client
-
PteroData<
T extends Object> - PteroErrorCode
- PteroErrorMeta
- PteroErrors
- PteroErrorScheduleMeta
- PteroErrorStringMeta
- PteroTranslationsClient
- PullFileBody
- Recaptcha
- RecoveryTokens
- RemoveNullResourcesInterceptor
- Remove any instance of null_resource, which looks like this:
- Rename
- RequestSchedule
- ResourceMeta
-
Shows on
application.createNode - RestoreBackup
-
deleteExistingFilesspecifies thetruncateparameter in the request. - ScheduleIncludes
- SchedulePermissionKeys
- ScheduleTask
- SendServerCommand
- Server
- ServerDatabase
- ServerDatabasesIncludes
- ServerFeatureLimits
- ServerFilters
- ServerIncludes
- ServerLimits
- ServerMeta
-
shows on
getServerDetails - ServerRelationships
- ServerSchedule
- ServerScheduleRelationships
- ServerSubuser
- SettingsPermissionKeys
- SftpDetails
- Signal
- SignedUrl
- SiteConfig
-
Sort<
T extends Sort< T> > - SshKey
- StartupMeta
-
Shows up on
listVariables - StartupPermissionKeys
- Stats
- StatsResources
- Subuser
- SubuserPermissions
- SystemPermissions
- Task
- TranslationData
- TwoFactorCode
- TwoFactorImage
- UpdateEmail
- UpdateImage
- UpdateNodeRequest
- UpdatePassword
- UpdateUserRequest
- User
- UserConfig
- UserPermissionKeys
- UsersSort
- WebsocketDetails
- WebsocketPermissionKeys
Enums
- Action
- ActivityFilterEnum
- GetServersQueryType
- adminAll - all servers, no exceptions (returns none if not admin)
- KnownNamespace
- PteroErrorCodeEnum
- PteroErrorMetaRule
- PteroErrorScheduleMetaRule
- ServerFilterEnum
- ServerPowerAction
- ServerPowerState
- ServerStatus
- SiteConfigOption
- An enum of possible json object names on the panel's html
Mixins
Extension Types
Extensions
-
ListItems
on FractalList<
T> - ParseSiteConfig on PteroClient
- A SiteConfiguration extension for accessing panel information that exists in the html
- PteroClientStuff on PteroClient
- PteroClientVisibleDio on PteroClient
- An extension that allows you to access the Dio instance used by the client.
Constants
- useTypeDirectly → const Deprecated
Typedefs
-
FractalAllocation
= Fractal<
Allocation> -
FractalAllocationList
= FractalList<
Allocation> -
FractalApiKey
= Fractal<
ApiKey> -
FractalApiKeyList
= FractalList<
ApiKey> -
FractalBackup
= Fractal<
Backup> -
FractalBackupList
= FractalList<
Backup> -
FractalDatabasePassword
= Fractal<
DatabasePassword> -
FractalDatabasesList
= FractalList<
Databases> -
FractalEgg
= Fractal<
Egg> -
FractalEggVariable
= Fractal<
EggVariable> -
FractalEggVariableList
= FractalList<
EggVariable> -
FractalFileObject
= Fractal<
FileObject> -
FractalFileObjectList
= FractalList<
FileObject> -
FractalMetaServer
= FractalMeta<
Server, ServerMeta> -
FractalNest
= Fractal<
Nest> -
FractalRecoveryTokens
= Fractal<
RecoveryTokens> -
FractalScheduleTask
= Fractal<
ScheduleTask> -
FractalScheduleTaskList
= FractalList<
ScheduleTask> -
FractalServer
= Fractal<
Server> -
FractalServerDatabase
= Fractal<
ServerDatabase> -
FractalServerDatabaseList
= FractalList<
ServerDatabase> -
FractalServerList
= FractalList<
Server> -
FractalServerSchedule
= Fractal<
ServerSchedule> -
FractalServerSubuser
= Fractal<
ServerSubuser> -
FractalServerSubuserList
= FractalList<
ServerSubuser> -
FractalSignedUrl
= Fractal<
SignedUrl> -
FractalStats
= Fractal<
Stats> -
FractalSubuserList
= FractalList<
Subuser> -
FractalSystemPermissions
= Fractal<
SystemPermissions> -
FractalTwoFactorImage
= Fractal<
TwoFactorImage> -
FractalUser
= Fractal<
Account> -
JsonMap
= Map<
String, Object?>
Exceptions / Errors
- ConfigNotFoundException
- An exception for when the site configuration could not be found
- GenericApiException
- Base ApiException class for dartactyl. All api errors should be an instance of this class
- NoConnectionPteroApiException
- We could not reach the server
- NoDataPteroApiException
- We reached the server, but we did not get any data
- PteroApiException
- A common exception class with whatever error data the server sent us
- PteroError