Versions in this module Expand all Collapse all v0 v0.2.2 Jul 28, 2026 Changes in this version + type ACMEConfig struct + DNSEnvironment map[string]string + DNSProvider string + Enabled bool + KeyType string + PreferWildcard bool + Provider string + SkipDNSNames []string + type CustomHTTP struct + func (h *CustomHTTP) DELETE(ctx context.Context, path string) (int, []byte, error) + func (h *CustomHTTP) GET(ctx context.Context, path string) (int, []byte, error) + func (h *CustomHTTP) POST(ctx context.Context, path string, body io.Reader) (int, []byte, error) + func (h *CustomHTTP) PUT(ctx context.Context, path string, body io.Reader) (int, []byte, error) type UserContext + func (c *UserContext) HTTP() *CustomHTTP + func (c *UserContext) ProvisionCerts(domain string) ([]byte, error) + func (c *UserContext) SetACMEConfig(domain string, config ACMEConfig) error v0.2.1 Jun 8, 2026 Changes in this version + const AccountRoleAdmin + const AccountRoleReseller + const AccountRoleUser + const DatabaseFormatGZ + const DatabaseFormatSQL + const PHPSelectorExtensionStateBuildIn + const PHPSelectorExtensionStateDisabled + const PHPSelectorExtensionStateEnabled + const SoftaculousProtocolHTTP + const SoftaculousProtocolHTTPS + const SoftaculousProtocolHTTPSWWW + const SoftaculousProtocolHTTPWWW + const SoftaculousScriptIDWordPress + const Unlimited + type API struct + func New(serverURL string, timeout time.Duration, cacheEnabled bool, debug bool) (*API, error) + func (a *API) GetURL() string + func (a *API) LoginAsAdmin(username string, passkey string) (*AdminContext, error) + func (a *API) LoginAsReseller(username string, passkey string) (*ResellerContext, error) + func (a *API) LoginAsUser(username string, passkey string) (*UserContext, error) + type Admin struct + type AdminContext struct + func (c *AdminContext) ConvertResellerToUser(username string, reseller string) error + func (c *AdminContext) ConvertUserToReseller(username string) error + func (c *AdminContext) CreateResellerPackage(pack ResellerPackage) error + func (c *AdminContext) DeleteResellerPackages(packs ...string) error + func (c *AdminContext) DisableRedis() error + func (c *AdminContext) EnableRedis() error + func (c *AdminContext) GetAllUsers() ([]string, error) + func (c *AdminContext) GetLicense() (*License, error) + func (c *AdminContext) GetLoginHistory() ([]*LoginHistory, error) + func (c *AdminContext) GetRedisStatus() (bool, string, error) + func (c *AdminContext) GetResellerPackage(packageName string) (ResellerPackage, error) + func (c *AdminContext) GetResellerPackages() ([]ResellerPackage, error) + func (c *AdminContext) GetResellers() ([]string, error) + func (c *AdminContext) LoginAsMyReseller(username string) (*ResellerContext, error) + func (c *AdminContext) MoveUserToReseller(username string, reseller string) error + func (c *AdminContext) RenameResellerPackage(oldPackName string, newPackName string) error + func (c *AdminContext) RestartDirectAdmin() error + func (c *AdminContext) UpdateDirectAdmin() error + func (c *AdminContext) UpdateHostname(hostname string) error + func (c *AdminContext) UpdateResellerPackage(pack ResellerPackage) error + type BasicSysInfo struct + AllowPasswordReset bool + Hostname string + Languages []string + LicenseError string + LicenseTrial bool + LicenseValid bool + OtpTrustDays int + Time time.Time + type CloudLinuxChartData struct + ChartTitle string + DataPoints []dataPoint + FaultEvents []string + Unit string + type CloudLinuxUser struct + CageFS string + Domain string + ID int + Limits struct{ ... } + Package string + Username string + type DNSRecord struct + Name string + TTL int + Type string + Value string + type Database struct + DefaultCharset string + DefaultCollation string + DefinerIssues int + EventCount int + Name string + RoutineCount int + SizeBytes int + TableCount int + TriggerCount int + UserCount int + ViewCount int + type DatabaseFormat string + type DatabaseProcess struct + Command string + Database string + Host string + ID int + Info string + State string + Time int + User string + type DatabaseUser struct + HostPatterns []string + Password string + User string + type DatabaseWithUser struct + Password string + User string + type Domain struct + Active bool + BandwidthQuota int + BandwidthUsage int + CGIEnabled bool + DefaultDomain bool + DiskQuota int + DiskUsage int + Domain string + IPAddresses []string + ModSecurityEnabled bool + OpenBaseDirEnabled bool + PHPEnabled bool + PHPSelectorEnabled bool + PHPVersion string + SSLEnabled bool + SafeMode bool + SubdomainUsage int + Subdomains []string + Suspended bool + Username string + type EmailAccount struct + DiskQuota int + DiskUsage int + Domain string + Password string + SendQuota int + SendUsage int + Suspended bool + Username string + type FileMetadata struct + AccessTime time.Time + BirthTime time.Time + ChangeTime time.Time + GID int + Group string + Mode string + ModifyTime time.Time + Name string + SizeBytes int + Symlink struct{ ... } + Type string + UID int + UnixMode int + User string + type License struct + Expires time.Time + LID int + Limits struct{ ... } + Name string + PID int + Type string + UID int + Usage struct{ ... } + type LoginHistory struct + Attempts int + Host string + Timestamp time.Time + type LoginKeyURL struct + AllowNetworks []string + Created time.Time + CreatedBy string + Expires time.Time + ID string + RedirectURL string + URL string + type Message struct + From string + FromName string + ID int + LegacyID string + Message string + Subject string + Timestamp time.Time + Unread bool + type PHPSelectorExtension struct + Description string + Name string + State string + type PHPSelectorList struct + AvailableVersions []*PHPSelectorVersion + DefaultVersion string + DomainsTabIsHidden bool + ExtensionsIsHidden bool + Result string + SelectedVersion string + SelectorEnabled bool + Timestamp float64 + func (l *PHPSelectorList) GetVersion(version string) (*PHPSelectorVersion, error) + type PHPSelectorOption struct + Comment string + Default string + Range string + Type string + type PHPSelectorVersion struct + Extensions []*PHPSelectorExtension + NameModifier string + Options map[string]*PHPSelectorOption + Status string + Version string + func (v *PHPSelectorVersion) GetEnabledExtensions() []string + type PHPVersion struct + ID string + Selected bool + Text string + Version string + type Package struct + AnonymousFTPEnabled bool + BandwidthQuota int + CGIEnabled bool + CPUQuota int + CatchallEnabled bool + CronEnabled bool + DNSControlEnabled bool + DomainPointerQuota int + DomainQuota int + EmailAutoresponderQuota int + EmailForwarderQuota int + EmailMailingListQuota int + EmailQuota int + FTPQuota int + GitEnabled bool + IOReadBandwidthMax int + IOReadIopsMax int + IOWriteBandwidthMax int + IOWriteIopsMax int + InodeQuota int + JailEnabled bool + Language string + LoginKeysEnabled bool + MemoryHigh int + MemoryMax int + MySQLQuota int + Name string + NginxEnabled bool + PHPEnabled bool + Quota int + RedisEnabled bool + SSHEnabled bool + SSLEnabled bool + Skin string + SpamAssassinEnabled bool + SubdomainQuota int + SuspendAtLimitEnabled bool + SysInfoEnabled bool + TasksMax int + WordPressEnabled bool + type Plugin struct + ID string + MenuEntry struct{ ... } + Role string + type Reseller struct + type ResellerContext struct + func (c *ResellerContext) AddUserIP(username string, ip string) error + func (c *ResellerContext) ChangeUserIP(username string, ip string) error + func (c *ResellerContext) CheckUserExists(username string) error + func (c *ResellerContext) CreatePackage(pack Package) error + func (c *ResellerContext) CreateUser(user UserConfig, password string, emailUser bool) error + func (c *ResellerContext) DeletePackages(packs ...string) error + func (c *ResellerContext) DeleteUsers(usernames ...string) error + func (c *ResellerContext) GetMyUsers() ([]*User, error) + func (c *ResellerContext) GetMyUsersWithData(retrieveConfig bool, retrieveUsage bool) ([]*User, error) + func (c *ResellerContext) GetPackage(packageName string) (*Package, error) + func (c *ResellerContext) GetPackages() ([]*Package, error) + func (c *ResellerContext) GetUserConfig(username string) (*UserConfig, error) + func (c *ResellerContext) GetUserUsage(username string) (*UserUsage, error) + func (c *ResellerContext) LoginAsMyUser(username string) (*UserContext, error) + func (c *ResellerContext) RenamePackage(oldPackName string, newPackName string) error + func (c *ResellerContext) SuspendUser(username string) error + func (c *ResellerContext) SuspendUsers(usernames ...string) error + func (c *ResellerContext) UnsuspendUser(username string) error + func (c *ResellerContext) UnsuspendUsers(usernames ...string) error + func (c *ResellerContext) UpdatePackage(pack Package) error + type ResellerPackage struct + OversellEnabled bool + UserQuota int + type Session struct + AllowedCommands []string + ConfigFeatures struct{ ... } + CustomDomainItems []struct{ ... } + CustombuildOptions struct{ ... } + Demo bool + DirectadminConfig struct{ ... } + EffectiveRole string + EffectiveUsername string + HavePluginHooksAdmin bool + HavePluginHooksReseller bool + HavePluginHooksUser bool + HomeDir string + LoginAsDNSControl bool + PHPMyAdminPublic bool + RealUsername string + SelectedDomain string + SessionID string + TicketsEnabled bool + type SoftaculousInstallation struct + DBCreated bool + DBPrefix string + DisplaySoftDBPass string + Domain string + FileIndex any + ID string + ITime int + ImportSrc string + Path string + ScriptID int + ScriptName string + SiteName string + SoftDB string + SoftDBhost string + SoftDBpass string + SoftDBuser string + URL string + Ver string + type SoftaculousScript struct + AdminEmail string + AdminPassword string + AdminUsername string + AutoUpgrade bool + AutoUpgradePlugins bool + AutoUpgradeThemes bool + DatabaseName string + DatabasePrefix string + Directory string + Domain string + Language string + NotifyOnInstall bool + NotifyOnUpdate bool + OverwriteExisting bool + Protocol string + SiteDescription string + SiteName string + func SoftaculousScriptWithDefaults() *SoftaculousScript + func (s *SoftaculousScript) Parse() (url.Values, error) + func (s *SoftaculousScript) Validate() error + type Subdomain struct + Domain string + PHPVersion string + PublicHTML string + Subdomain string + type SysInfo struct + CPUCount int + CPUs map[string]struct{ ... } + MemInfo struct{ ... } + Services map[string]struct{ ... } + SystemLoad struct{ ... } + Uptime struct{ ... } + type User struct + BandwidthLimit int + BandwidthUsage int + Config UserConfig + Created time.Time + Domains []string + DomainsLimit int + DomainsUsage int + IPs []string + Package string + QuotaLimit int + QuotaUsage int + Suspended bool + SuspendedReason string + Usage UserUsage + Username string + type UserConfig struct + AFTPEnabled bool + APIAllowPassword bool + AccountEnabled bool + AutorespondersLimit int + BandwidthLimit int + CGIEnabled bool + CPUQuota string + CatchAllEnabled bool + ClamAVEnabled bool + Creator string + CronEnabled bool + DNSControlEnabled bool + DateCreated string + DocsRoot string + Domain string + DomainPointersLimit int + Domains []string + DomainsLimit int + Email string + EmailAccountsLimit int + EmailForwardersLimit int + FTPAccountsLimit int + FeatureSets []string + GitEnabled bool + IOReadBandwidthMax string + IOReadIOPSMax string + IOWriteBandwidthMax string + IOWriteIOPSMax string + IP string + InodeLimit int + JailEnabled bool + Language string + LetsEncrypt int + LoginKeysEnabled bool + MailPartition string + MailingListsLimit int + MemoryHigh string + MemoryMax string + MySQLConf string + MySQLDatabasesLimit int + NS1 string + NS2 string + Name string + NginxEnabled bool + PHPEnabled bool + Package string + PluginsBlacklist []string + PluginsWhitelist []string + QuotaLimit int + RedisEnabled bool + SSHEnabled bool + SSLEnabled bool + SecurityQuestionsEnabled bool + Skin string + SpamEnabled bool + SubdomainsLimit int + Suspended bool + SysInfoEnabled bool + TasksMax string + TwoStepAuthDescription string + TwoStepAuthEnabled bool + UserType string + Username string + Users []string + UsersLimit int + UsersManageDomains int + WordPressEnabled bool + Zoom int + type UserContext struct + User User + func (c *UserContext) AddDomainIP(domain string, ip string, createDNSRecords bool) error + func (c *UserContext) ChangeWordPressUserPassword(locationID string, userID int, password string) error + func (c *UserContext) CheckDNSRecordExists(checkField string, domain string, dnsRecord DNSRecord) error + func (c *UserContext) CheckDomainExists(domain string) error + func (c *UserContext) CloudLinuxGetUsageCharts(period string, id string) ([]*CloudLinuxChartData, error) + func (c *UserContext) CloudLinuxGetUsageChartsAsImage(period string, id string, format string) (string, error) + func (c *UserContext) CloudLinuxGetUsers() ([]*CloudLinuxUser, error) + func (c *UserContext) CreateArchive(destinationPath string, sources ...string) error + func (c *UserContext) CreateBackup(domain string, backupItems ...string) error + func (c *UserContext) CreateBackupAllItems(domain string) error + func (c *UserContext) CreateDNSRecord(domain string, dnsRecord DNSRecord) error + func (c *UserContext) CreateDatabase(database *Database) error + func (c *UserContext) CreateDatabaseUser(databaseUser *DatabaseUser) error + func (c *UserContext) CreateDatabaseWithUser(database *DatabaseWithUser) error + func (c *UserContext) CreateDirectory(path string) error + func (c *UserContext) CreateDomain(domain Domain) error + func (c *UserContext) CreateEmailAccount(emailAccount EmailAccount) error + func (c *UserContext) CreateEmailForwarder(domain string, user string, emails ...string) error + func (c *UserContext) CreateLoginURL(loginKeyURL *LoginKeyURL) error + func (c *UserContext) CreatePHPMyAdminLoginURL() (string, error) + func (c *UserContext) CreateSession() error + func (c *UserContext) CreateSubdomain(subdomain Subdomain) error + func (c *UserContext) CreateWebmailLoginURL(address string) (string, error) + func (c *UserContext) CreateWordPressInstall(install WordPressInstall, createDatabase bool) error + func (c *UserContext) CreateWordPressInstallQuick(install WordPressInstallQuick) error + func (c *UserContext) DeleteDNSRecords(dnsRecords ...DNSRecord) error + func (c *UserContext) DeleteDatabase(databaseName string) error + func (c *UserContext) DeleteDomains(deleteData bool, domains ...string) error + func (c *UserContext) DeleteEmailAccount(domain string, name string) error + func (c *UserContext) DeleteEmailForwarders(domain string, names ...string) error + func (c *UserContext) DeleteFiles(skipTrash bool, files ...string) error + func (c *UserContext) DeleteSubdomains(deleteData bool, domain string, subdomains ...string) error + func (c *UserContext) DeleteWordPressInstall(id string) error + func (c *UserContext) DownloadDatabase(name string, format DatabaseFormat) ([]byte, error) + func (c *UserContext) DownloadDatabaseToDisk(name string, format DatabaseFormat, outputPath string) error + func (c *UserContext) DownloadFile(filePath string) ([]byte, error) + func (c *UserContext) DownloadFileToDisk(filePath string, outputPath string) error + func (c *UserContext) ExportDatabase(databaseName string, gzip bool) ([]byte, error) + func (c *UserContext) ExtractArchive(destinationDir string, source string, mergeAndOverwrite bool) error + func (c *UserContext) GetBackups(domain string) ([]string, error) + func (c *UserContext) GetBasicSysInfo() (*BasicSysInfo, error) + func (c *UserContext) GetDNSRecords(domain string) ([]DNSRecord, error) + func (c *UserContext) GetDatabase(databaseName string) (*Database, error) + func (c *UserContext) GetDatabaseProcesses() ([]*DatabaseProcess, error) + func (c *UserContext) GetDatabases() ([]*Database, error) + func (c *UserContext) GetDomain(domainName string) (Domain, error) + func (c *UserContext) GetDomains() ([]Domain, error) + func (c *UserContext) GetEmailAccounts(domain string) ([]EmailAccount, error) + func (c *UserContext) GetEmailEnabled(domain string) (bool, error) + func (c *UserContext) GetEmailForwarders(domain string) (map[string][]string, error) + func (c *UserContext) GetFileMetadata(filePath string) (*FileMetadata, error) + func (c *UserContext) GetLoginURLs() ([]*LoginKeyURL, error) + func (c *UserContext) GetMessages() ([]*Message, error) + func (c *UserContext) GetMyUserConfig() (*UserConfig, error) + func (c *UserContext) GetMyUserUsage() (*UserUsage, error) + func (c *UserContext) GetMyUsername() string + func (c *UserContext) GetPHPVersions(domainName string) ([]*PHPVersion, error) + func (c *UserContext) GetPlugins() ([]*Plugin, error) + func (c *UserContext) GetSessionInfo() (*Session, error) + func (c *UserContext) GetSysInfo() (*SysInfo, error) + func (c *UserContext) GetWordPressInstalls() ([]*WordPressLocation, error) + func (c *UserContext) GetWordPressSSOLink(locationID string, userID int) (string, error) + func (c *UserContext) GetWordPressUsers(locationID string) ([]*WordPressUser, error) + func (c *UserContext) ImportDatabase(databaseName string, emptyExistingDatabase bool, sql []byte) error + func (c *UserContext) IssueSSL(domain string, hostnamesToCertify ...string) error + func (c *UserContext) ListDomains() (domainList []string, err error) + func (c *UserContext) ListSubdomains(domain string) (subdomainList []string, err error) + func (c *UserContext) Login() error + func (c *UserContext) MovePath(source string, destination string, overwrite bool) error + func (c *UserContext) PHPSelectorDisableExtension(version string, extension string) error + func (c *UserContext) PHPSelectorEnableExtension(version string, extension string) error + func (c *UserContext) PHPSelectorGetDefaultVersion() (*PHPSelectorVersion, error) + func (c *UserContext) PHPSelectorGetSelectedVersion() (*PHPSelectorVersion, error) + func (c *UserContext) PHPSelectorGetVersion(version string) (*PHPSelectorVersion, error) + func (c *UserContext) PHPSelectorListVersions() (*PHPSelectorList, error) + func (c *UserContext) PHPSelectorSetExtensions(version string, extensions ...string) error + func (c *UserContext) PHPSelectorSetOptions(version string, options map[string]string) error + func (c *UserContext) PHPSelectorSetVersion(version string) error + func (c *UserContext) RestoreBackup(domain string, backupFilename string, backupItems ...string) error + func (c *UserContext) RestoreBackupAllItems(domain string, backupFilename string) error + func (c *UserContext) SetDefaultDomain(domain string) error + func (c *UserContext) SetPHPVersion(domain string, versionID string) error + func (c *UserContext) SoftaculousCreateLoginURL(installID string) (string, error) + func (c *UserContext) SoftaculousInstallScript(script *SoftaculousScript, scriptID int) error + func (c *UserContext) SoftaculousListInstallations() ([]*SoftaculousInstallation, error) + func (c *UserContext) SoftaculousUninstallScript(installID string, deleteFiles bool, deleteDB bool) error + func (c *UserContext) ToggleDKIM(domain string, status bool) error + func (c *UserContext) ToggleEmailEnabled(domain string, enabled bool) error + func (c *UserContext) UpdateDNSRecord(domain string, originalDNSRecord DNSRecord, updatedDNSRecord DNSRecord) error + func (c *UserContext) UpdateDatabaseUserHosts(username string, hosts []string) error + func (c *UserContext) UpdateDatabaseUserPassword(username string, password string) error + func (c *UserContext) UpdateDomain(domain Domain) error + func (c *UserContext) UpdateEmailAccount(emailAccount EmailAccount) error + func (c *UserContext) UpdateEmailForwarder(domain string, user string, emails ...string) error + func (c *UserContext) UpdateSubdomainRoot(subdomain Subdomain) error + func (c *UserContext) UploadFile(uploadToPath string, fileData []byte, overwrite bool) error + func (c *UserContext) UploadFileFromDisk(uploadToPath string, localFilePath string, overwrite bool) error + func (c *UserContext) UseInternalMailHandler(domain string, enable bool) error + func (c *UserContext) VerifyEmailAccount(address string, password string) error + type UserUsage struct + AutoResponders struct{ ... } + BandwidthBytes struct{ ... } + DBQuotaBytes int + DomainPointers struct{ ... } + Domains struct{ ... } + EmailAccounts struct{ ... } + EmailDeliveries int + EmailDeliveriesIncoming int + EmailDeliveriesOutgoing int + EmailForwarders struct{ ... } + EmailQuotaBytes int + FTPAccounts struct{ ... } + Inode struct{ ... } + MailingLists struct{ ... } + MySQLDatabases struct{ ... } + OtherQuotaBytes int + QuotaBytes struct{ ... } + QuotaWithoutSystemBytes int + Subdomains struct{ ... } + type WordPressInstall struct + AdminEmail string + AdminName string + AdminPass string + DBName string + DBPass string + DBPrefix string + DBUser string + FilePath string + Title string + type WordPressInstallQuick struct + AdminEmail string + AdminName string + AdminPass string + FilePath string + Title string + type WordPressLocation struct + FilePath string + Host string + ID string + WebPath string + WordPress struct{ ... } + type WordPressUser struct + DisplayName string + Email string + ID int + Login string + Registered time.Time + Roles []string
Go to main page