API reference

Schemas

Every object of the API.

Objects the API sends and receives. Fields marked always are present in every response.

ACLKey

Field	Type
`description` always	string
`group` always	string
`key` always	string
`label` always	string

AcctPrefs

Field	Type
`contact_email`	string
`contact_email2`	string
`locale`	string
`notifications`	map of boolean

AdminBrandingView

Field Type

colors BrandingColors

custom boolean

defaults always

object

Field	Type
`colors` always	BrandingColors
`product_name` always	string

favicon always string

favicon_url string

links array of BrandingLink

logo_dark_svg string

logo_svg string

product_name string

public_contact BrandingContact

scope always string

updated_at integer

AgentprotoDiskUsage

Field	Type
`free_bytes` always	integer
`inodes_free` always	integer
`inodes_total` always	integer
`mount` always	string
`total_bytes` always	integer

AgentprotoProcess

Field	Type
`command` always	string
`cpu` always	number
`elapsed_seconds` always	integer
`mem` always	number
`pid` always	integer
`rss_bytes` always	integer
`user` always	string

AgentprotoServiceStatus

Field	Type
`active` always	string
`enabled` always	boolean
`failed`	array of string
`group`	string
`installed` always	boolean
`label`	string
`main_pid` always	integer
`memory_bytes` always	integer
`name`	string
`protected`	boolean
`restarts` always	integer
`since`	integer
`sub` always	string
`unit`	string

AgentprotoSystemStats

Field	Type
`agent_version`	string
`cgroup_v2`	boolean
`cpu_model` always	string
`cpus`	integer
`disks` always	array of AgentprotoDiskUsage
`hostname`	string
`kernel`	string
`load1` always	number
`load15` always	number
`load5` always	number
`mem_available_bytes` always	integer
`mem_total_bytes`	integer
`os_id`	string
`os_pretty_name`	string
`os_version`	string
`selinux`	string
`swap_free_bytes` always	integer
`swap_total_bytes` always	integer
`uptime_seconds` always	integer
`virtualization` always	string

AlertView

Field	Type
`description`	string
`key`	string
`label`	string
`priority` always	string

AppView

Field	Type
`account_id`	string
`branch`	string
`created_at`	integer
`current_release`	string
`deploy_key_pub`	string
`deploy_ready` always	boolean
`deploy_script`	string
`deploy_timeout`	integer
`domain`	string
`domain_id`	string
`git_connection_id`	string
`has_composer_auth`	boolean
`has_deploy_hook`	boolean
`has_webhook_secret`	boolean
`health_path`	string
`host_key_fingerprints`	array of string
`id`	string
`inject_env`	boolean
`keep_releases`	integer
`known_hosts`	string
`last_deployment`	StoreDeployment
`name`	string
`php_version`	string
`port`	integer
`processes`	array of StoreAppProcess
`push_to_deploy`	boolean
`repo_full_name`	string
`repo_id`	integer
`repo_url`	string
`runtime_version`	string
`scheduler`	boolean
`shared_paths`	array of string
`start_command`	string
`status`	string
`type`	string
`updated_at`	integer
`web_dir`	string
`webhook_url` always	string

BlockView

Field	Type
`country`	string
`created_at`	integer
`created_by`	string
`expires_at`	integer
`id`	string
`kind`	string
`list`	string
`reason`	string
`value`	string

BrandingColors

Field	Type
`accent` always	string
`accent_dark` always	string
`accent_strong` always	string

BrandingContact

Field	Type
`company` always	string
`email` always	string
`phone` always	string
`url` always	string

BrandingInput

Field	Type
`colors`	BrandingColors
`favicon`	string
`links`	array of BrandingLink
`logo_dark_svg`	string
`logo_svg`	string
`product_name`	string
`public_contact`	BrandingContact

BrandingLink

Field	Type
`label` always	string
`url` always	string

BrandingView

Field	Type
`colors` always	BrandingColors
`custom` always	boolean
`favicon_url` always	string
`links` always	array of BrandingLink
`logo_dark_svg` always	string
`logo_svg` always	string
`product_name` always	string
`public_contact` always	BrandingContact
`updated_at` always	integer

CertPreview

Field	Type
`chain_certs` always	integer
`covers_domain`	boolean
`domains` always	array of string
`issuer` always	string
`key_match` always	boolean
`key_stored` always	boolean
`not_after` always	integer
`not_before` always	integer
`validation` always	string
`warnings` always	array of string

CertReq

Field	Type
`ca_bundle`	string
`cert_id`	string
`certificate`	string
`domain_id`	string
`friendly_name`	string
`private_key`	string

ChannelReq

Field	Type
`enabled`	boolean
`min_priority`	string
`target`	string
`type`	string

ChannelView

Field	Type
`created_at`	integer
`enabled`	boolean
`has_secret`	boolean
`id`	string
`min_priority`	string
`target`	string
`type` always	string
`updated_at`	integer

ClientSettings

Field Type

address always string

autoconfig_url always string

autodiscover_url always string

plain always

object

Field	Type
`imap` always	ServerEndpoint
`pop3` always	ServerEndpoint
`smtp` always	ServerEndpoint

secure always

object

Field	Type
`imap` always	ServerEndpoint
`pop3` always	ServerEndpoint
`smtp` always	ServerEndpoint

username always string

webmail_url always string

CloudflareConflict

Field	Type
`existing` always	array of CloudflareRecord
`locked` always	boolean
`reason` always	string
`want` always	CloudflareWant

CloudflarePlan

Field	Type
`add` always	array of CloudflareRecord
`adopt` always	array of CloudflareRecord
`conflicts` always	array of CloudflareConflict
`remove` always	array of CloudflareRecord
`shared` always	array of CloudflareRecord
`theirs` always	array of CloudflareRecord
`unchanged` always	integer
`update` always	array of CloudflareRecord

CloudflareRecord

Field	Type
`comment`	string
`content`	string
`data`	any
`id`	string
`meta`	map of any
`name` always	string
`priority`	integer
`proxied`	boolean
`ttl` always	integer
`type` always	string

CloudflareWant

Field	Type
`Key` always	string
`comment`	string
`content`	string
`data`	any
`id`	string
`meta`	map of any
`name`	string
`priority`	integer
`proxied`	boolean
`ttl`	integer
`type`	string

CreateAccountReq

Field	Type
`cgi`	boolean
`contact_email`	string
`database_node`	string
`domain`	string
`ip_id`	string
`locale`	string
`mail_node`	string
`mail_routing`	string
`make_reseller`	boolean
`owner_id`	string
`owns_itself`	boolean
`package_id`	string
`password`	string
`shell`	string
`spam_box`	boolean
`spam_filter`	boolean
`username`	string

CreateForwarderReq

Field	Type
`dest_type`	string
`destinations`	array of string
`domain_id`	string
`fail_message`	string
`local_part`	string

CreateMailReq

Field	Type
`domain_id`	string
`local_part`	string
`password`	string
`quota_mb`	integer

DbRow

Field	Type
`account_id`	string
`name` always	string
`size_bytes` always	integer
`tables` always	integer
`username`	string

DefaultAddressView

Field	Type
`action` always	string
`configured` always	boolean
`destination`	string
`domain` always	string
`domain_id` always	string
`fail_message`	string

DestReq

Field	Type
`config`	HostingDestConfig
`enabled`	boolean
`name`	string
`new_key`	boolean
`secret`	string
`timeout_s`	integer
`type`	string

DomainSSLView

Field	Type
`covered` always	boolean
`has_cert` always	boolean
`issuer`	string
`not_after`	integer
`problem`	string

DomainView

Field	Type
`docroot`	string
`force_https`	boolean
`id`	string
`name`	string
`parent_id`	string
`parent_name`	string
`php_ini_count` always	integer
`php_version`	string
`redirect_count` always	integer
`redirect_to`	string
`ssl`	DomainSSLView
`status`	string
`subdomains` always	integer
`type`	string

Entry

Field	Type
`account_exists`	boolean
`account_id`	string
`destination_id`	string
`format`	string
`id`	string
`layout`	string
`location`	string
`main_domain`	string
`run_id`	string
`schedule`	string
`schedules` always	array of string
`size_bytes`	integer
`status`	string
`taken_at`	integer
`username`	string

FeaturesFeature

Field	Type
`description` always	string
`future`	boolean
`group` always	string
`key` always	string
`label` always	string

FsResult

Field	Type
`conflict`	boolean
`conflicts`	array of string
`content`	string
`count`	integer
`encoding`	string
`etag`	string
`items`	array of any
`line_ending`	string
`modified`	integer
`path`	string
`paths`	array of string
`size`	integer
`trash`	array of any
`truncated`	boolean

FtpInput

Field	Type
`domain_id`	string
`home_dir`	string
`login`	string
`password`	string
`quota_mb`	integer

FtpItem

Field	Type
`account_id`	string
`created_at`	integer
`dir_missing` always	boolean
`domain`	string
`domain_id`	string
`full_login`	string
`has_password`	boolean
`home_dir`	string
`id`	string
`kind`	string
`login`	string
`quota_mb`	integer
`updated_at`	integer
`used_bytes`	integer

FwRuleView

Field	Type
`action` always	string
`comment`	string
`created_at`	integer
`enabled`	boolean
`id`	string
`ports`	string
`position`	integer
`protocol`	string
`source`	string

GithubRepo

Field	Type
`clone_url` always	string
`default_branch` always	string
`full_name` always	string
`html_url` always	string
`id` always	integer
`private` always	boolean
`pushed_at` always	string

GlobalcfgMail

Field	Type
`alt_port` always	integer
`message_size_mb` always	integer
`smarthost` always	GlobalcfgSmarthost

GlobalcfgSmarthost

Field	Type
`enabled` always	boolean
`host` always	string
`port` always	integer
`user` always	string

GlobalcfgWeb

Field	Type
`cloudflare_ranges`	array of string
`keepalive` always	boolean
`timeout_seconds` always	integer
`tls_protocols` always	string
`worker_connections` always	integer

HostingAccountSettings

Field	Type
`bandwidth_exceeded_action`	string
`bandwidth_page_html`	string
`suspended_page_html`	string

HostingAppInput

Field	Type
`branch`	string
`composer_auth`	string
`create_database`	boolean
`deploy_script`	string
`deploy_timeout`	integer
`domain_id`	string
`git_connection_id`	string
`health_path`	string
`inject_env`	boolean
`keep_releases`	integer
`name`	string
`php_version`	string
`push_to_deploy`	boolean
`repo_full_name`	string
`repo_url`	string
`runtime_version`	string
`scheduler`	boolean
`shared_paths`	array of string
`start_command`	string
`type`	string
`web_dir`	string

HostingCFDomain

Field	Type
`cf_status`	string
`cf_zone_id`	string
`link`	StoreCloudflareZone
`name` always	string
`proxy`	map of boolean
`state` always	string
`zone_id` always	string

HostingCFOverview

Field	Type
`connection`	StoreCloudflareConnection
`domains` always	array of HostingCFDomain
`error`	string

HostingCFPreview

Field	Type
`cf_status` always	string
`cf_zone_id` always	string
`mail_at_cloudflare` always	boolean
`mail_note`	string
`plan` always	CloudflarePlan
`proxied` always	integer
`skipped` always	array of string
`zone` always	string

HostingCSRSubject

Field	Type
`country` always	string
`email` always	string
`locality` always	string
`org_unit` always	string
`organization` always	string
`state` always	string

HostingDeliverabilityReport

Field	Type
`checked_at` always	integer
`domain` always	string
`domain_id` always	string
`ok` always	boolean
`records` always	array of HostingRecordCheck
`spf_custom` always	StoreSPFCustom
`zone_local` always	boolean

HostingDestConfig

Field	Type
`access_key`	string
`auth`	string
`bucket`	string
`endpoint`	string
`host`	string
`host_key`	string
`path` always	string
`path_style`	boolean
`port`	integer
`public_key`	string
`region`	string
`tls`	string
`user`	string

HostingDomainInput

Field	Type
`docroot`	string
`label`	string
`name`	string
`parent_id`	string
`type`	string

HostingDomainPlan

Field	Type
`blockers` always	array of string
`from` always	string
`ok` always	boolean
`renames` always	array of StoreDomainRename
`steps` always	array of string
`to` always	string

HostingExportedFilter

Field	Type
`actions` always	array of StoreFilterAction
`enabled` always	boolean
`mailbox` always	string
`match` always	string
`name` always	string
`rules` always	array of StoreFilterRule

HostingFTPSession

Field	Type
`file` always	string
`host` always	string
`login` always	string
`percent` always	integer
`pid` always	integer
`seconds` always	integer
`speed` always	integer
`state` always	string

HostingFiltersExport

Field	Type
`filters` always	array of HostingExportedFilter
`format` always	string
`version` always	integer

HostingGitHubAppView

Field	Type
`configured` always	boolean
`connections`	integer
`created_at`	integer
`html_url`	string
`name`	string
`owner`	string
`slug`	string

HostingHostnameReport

Field	Type
`checked_at` always	integer
`helo` always	string
`hostname` always	string
`ip` always	string
`ok` always	boolean
`records` always	array of HostingRecordCheck
`zone_local`	string

HostingImportDecisions

Field	Type
`auto_apply`	boolean
`ip_id`	string
`keep_dns_ip`	boolean
`overwrite`	boolean
`owner_id`	string
`package_id`	string
`skip_databases`	boolean
`skip_dns`	boolean
`skip_home`	boolean
`skip_mail`	boolean
`url`	string
`username`	string

HostingImportResult

Field	Type
`dry_run` always	boolean
`records` always	integer
`soa_imported` always	boolean

HostingLogSettings

Field	Type
`archive`	boolean
`prune`	boolean

HostingMXEntry

Field	Type
`host` always	string
`local` always	boolean
`priority` always	integer

HostingMailAdminSettings

Field	Type
`auto_hold`	boolean
`default_max_per_hour`	integer
`retention_days`	integer
`unique_recipients_alert`	integer

HostingMassMail

Field	Type
`body`	string
`from_email`	string
`from_name`	string
`hostname`	string
`reseller_id`	string
`resellers`	boolean
`subject`	string

HostingOSUpdateOverview

Field	Type
`hour` always	integer
`running` always	boolean
`servers` always	array of HostingOSUpdateServer

HostingOSUpdateServer

Field	Type
`enabled` always	boolean
`error`	string
`last`	UpdateOSResult
`name` always	string
`node_id`	string
`role` always	string
`running` always	boolean

HostingPlanCheck

Field	Type
`detail`	string
`ok` always	boolean
`step` always	string

HostingRecordCheck

Field	Type
`expected` always	string
`kind` always	string
`local`	array of string
`local_status`	string
`name` always	string
`problems` always	array of string
`published` always	array of string
`repairable` always	boolean
`status` always	string
`type` always	string

HostingRecordInput

Field	Type
`content`	string
`name`	string
`priority`	integer
`ttl`	integer
`type`	string

HostingRemoteAccount

Field	Type
`conflicts` always	array of string
`domain` always	string
`owner` always	string
`plan` always	string
`suspended` always	boolean
`user` always	string

HostingRemoteAnalysis

Field	Type
`accounts` always	array of HostingRemoteAccount
`at` always	integer
`home_free_kb` always	integer
`type` always	string
`version` always	string

HostingRenamePlan

Field	Type
`blockers` always	array of string
`changes` always	array of StoreNameChange
`checks` always	array of HostingPlanCheck
`from` always	string
`ok` always	boolean
`steps` always	array of string
`to` always	string

HostingRestoreOptions

Field	Type
`databases` always	boolean
`home` always	boolean
`ip_id` always	string
`mail` always	boolean
`overwrite` always	boolean
`trust_foreign` always	boolean

HostingSSLSettings

Field	Type
`key_type`	string
`profile`	string

HostingValkeyView

Field	Type
`enabled` always	boolean
`host`	string
`maxmemory_mb`	integer
`password`	string
`port`	integer
`status`	string

HostingWorkerOptions

Field	Type
`backoff` always	integer
`connection` always	string
`force` always	boolean
`horizon` always	boolean
`max_time` always	integer
`memory` always	integer
`queue` always	string
`sleep` always	integer
`timeout` always	integer
`tries` always	integer

ImportReq

Field	Type
`decisions`	HostingImportDecisions
`path`	string
`url`	string

Item

Field	Type
`detected` always	string
`domain` always	string
`domain_id` always	string
`effective` always	string
`mx` always	array of HostingMXEntry
`routing` always	string

LicenseInfo

Field	Type
`grace_ends_at`	integer
`ip` always	string
`last_checkin_at`	integer
`last_checkin_error`	string
`lease_expires_at`	integer
`lease_issued_at`	integer
`license_id`	string
`license_server` always	string
`next_checkin_at`	integer
`plan`	string
`read_only` always	boolean
`readonly_since`	integer
`register_url` always	string
`server_pub` always	string
`status` always	string
`trial_ends_at`	integer

LimitView

Field	Type
`max`	integer
`used` always	integer

LoginReq

Field	Type
`password`	string
`username`	string

NodeVersion

Field	Type
`id` always	string
`name` always	string
`role` always	string
`status` always	string
`version` always	string

PackageReq

Field	Type
`bw_limit_mb`	integer
`cgi`	boolean
`dedicated_ip`	boolean
`default_email_quota_mb`	integer
`digest_auth`	boolean
`disk_quota_mb`	integer
`feature_list_id`	string
`isolation`	StoreIsolation
`locale`	string
`max_addon`	integer
`max_email`	integer
`max_email_per_hour`	integer
`max_email_quota_mb`	integer
`max_ftp`	integer
`max_parked`	integer
`max_sql`	integer
`max_sub`	integer
`name`	string
`php_max_children`	integer
`shell`	string
`theme`	string

PoliciesView

Field	Type
`admin_allowed_ips` always	array of string
`admin_password_max_age_days` always	integer
`my_ip`	string
`password_strength` always	map of integer
`require_2fa_admins` always	boolean
`require_2fa_customers` always	boolean
`smtp_restriction` always	boolean

Problem

Field	Type
`detail`	string
`fields`	map of string Per-field messages (form validation)
`status` always	integer
`title` always	string
`type` always	string https://kypanel.com/problems/<code>

RedirectReq

Field	Type
`code`	integer
`domain_id`	string
`path`	string
`target_url`	string
`wildcard`	boolean
`www_mode`	string

ResellerBrief

Field	Type
`id` always	string
`main_domain` always	string
`nameservers` always	array of string
`username` always	string

ResellerReq

Field	Type
`acl_list_id`	string
`bw_limit_mb`	integer
`disk_limit_mb`	integer
`max_accounts`	integer
`nameservers`	array of string
`oversell_bw`	boolean
`oversell_disk`	boolean
`owns_itself`	boolean
`panel_hostname`	string

Result

Field	Type
`channel_id` always	string
`error`	string
`ok` always	boolean
`target` always	string
`type` always	string

ServerEndpoint

Field	Type
`host` always	string
`port` always	integer
`security` always	string

ServiceView

Field	Type
`active`	string
`auto_restarts_last_hour` always	integer
`enabled`	boolean
`failed`	array of string
`group`	string
`installed`	boolean
`label`	string
`last_restart_at`	integer
`main_pid`	integer
`memory_bytes`	integer
`monitored` always	boolean
`name`	string
`protected`	boolean
`restarts`	integer
`since`	integer
`sub`	string
`unit`	string

SessionResp

Field	Type
`acl`	array of string
`acting_as` always	boolean
`authenticated` always	boolean
`csrf_token`	string
`expires_at`	integer
`force_password_change` always	boolean
`is_root` always	boolean
`mfa_required` always	boolean
`password_expired`	boolean
`reseller`	ResellerBrief
`role`	string
`two_factor_enabled` always	boolean
`two_factor_setup_required` always	boolean
`username`	string

SettingsCategory

Field	Type
`key` always	string
`label` always	string

SettingsOption

Field	Type
`label` always	string
`value` always	any

SettingsView

Field	Type
`mail`	GlobalcfgMail
`smarthost_password_set` always	boolean
`web`	GlobalcfgWeb

SshAddReq

Field	Type
`authorize`	boolean
`bits`	integer
`name`	string
`passphrase`	string
`private_key`	string
`public_key`	string
`type`	string

SsoReq

Field	Type
`goto`	string
`panel`	string

StoreACLList

Field	Type
`id` always	string
`keys` always	array of string
`name` always	string
`resellers` always	integer
`updated_at` always	integer

StoreAPIToken

Field	Type
`allowed_ips` always	array of string
`created_at` always	integer
`expires_at`	integer
`id` always	string
`last_used_at`	integer
`last_used_ip`	string
`name` always	string
`prefix` always	string
`principal_id` always	string
`principal_type` always	string
`scopes` always	array of string

StoreAccount

Field	Type
`bw_exceeded` always	boolean
`bw_limit_mb`	integer
`bw_used_month_mb` always	integer
`cgi` always	boolean
`contact_email` always	string
`created_at` always	integer
`db_count` always	integer
`db_prefix` always	string
`db_used_bytes` always	integer
`default_email_quota_mb`	integer
`disk_quota_mb`	integer
`disk_used_mb` always	integer
`feature_list_id` always	string
`home_dir` always	string
`id` always	string
`inodes_limit`	integer
`inodes_used` always	integer
`ip_address` always	string
`ip_id` always	string
`is_reseller` always	boolean
`locale` always	string
`main_domain` always	string
`make_reseller` always	boolean
`max_addon`	integer
`max_email`	integer
`max_email_per_hour`	integer
`max_email_quota_mb`	integer
`max_ftp`	integer
`max_parked`	integer
`max_sql`	integer
`max_sub`	integer
`owner_id` always	string
`owner_name` always	string
`package_id` always	string
`package_name` always	string
`php_max_children`	integer
`shell` always	string
`status` always	string
`suspend_locked` always	boolean
`suspend_reason` always	string
`suspended_at`	integer
`suspended_by`	string
`theme` always	string
`uid` always	integer
`username` always	string

StoreAccountCounts

Field	Type
`active` always	integer
`disk_used_mb` always	integer
`over_bandwidth` always	integer
`over_quota` always	integer
`suspended` always	integer
`total` always	integer

StoreAccountOwner

Field	Type
`accounts` always	integer
`id` always	string
`username` always	string

StoreAccountUsage

Field	Type
`bw_limit_mb` always	integer
`disk_quota_mb` always	integer
`max_addon` always	integer
`max_email` always	integer
`max_email_quota_mb` always	integer
`max_ftp` always	integer
`max_parked` always	integer
`max_sql` always	integer
`max_sub` always	integer

StoreAdminTwoFactor

Field	Type
`disabled` always	boolean
`enabled_at`	integer
`id` always	string
`is_root` always	boolean
`issuer`	string
`last_login_at`	integer
`two_factor_enabled` always	boolean
`username` always	string

StoreAppProcess

Field	Type
`account_id` always	string
`app_id` always	string
`command` always	string
`created_at` always	integer
`enabled` always	boolean
`id` always	string
`instances` always	integer
`kind` always	string
`name` always	string
`options` always	any
`stop_wait` always	integer
`updated_at` always	integer

StoreAutoSSLAccount

Field	Type
`account_id` always	string
`last_run_at`	integer
`next_run_at`	integer
`problems` always	integer
`status` always	string
`username` always	string

StoreBFEvent

Field	Type
`action` always	string
`at` always	integer
`by` always	string
`failures` always	integer
`id` always	integer
`kind` always	string
`reason`	string
`service`	string
`value` always	string

StoreBFRecord

Field	Type
`created_at` always	integer
`created_by` always	string
`expires_at`	integer
`id` always	string
`kind` always	string
`list` always	string
`reason`	string
`value` always	string

StoreBackupConfig

Field	Type
`backup_dir`	string
`db_mode`	string
`enabled`	boolean
`excludes`	array of string
`include`	StoreBackupInclude
`min_free_pct`	integer
`retain_local`	boolean
`retention`	StoreBackupRetention
`schedule`	StoreBackupSchedule
`strict_retention`	boolean
`type`	string
`updated_at`	integer

StoreBackupDestination

Field	Type
`config` always	any
`created_at` always	integer
`enabled` always	boolean
`has_secret` always	boolean
`id` always	string
`last_error`	string
`last_validated_at`	integer
`last_validation_ok`	boolean
`name` always	string
`timeout_s` always	integer
`type` always	string

StoreBackupInclude

Field	Type
`accounts` always	boolean
`bandwidth` always	boolean
`logs` always	boolean
`suspended` always	boolean
`system` always	boolean

StoreBackupRetention

Field	Type
`daily` always	integer
`monthly` always	integer
`weekly` always	integer

StoreBackupRun

Field	Type
`accounts_failed` always	integer
`accounts_ok` always	integer
`accounts_total` always	integer
`bytes_total` always	integer
`finished_at`	integer
`id` always	string
`job_id`	string
`kind` always	string
`schedule`	string
`started_at` always	integer
`status` always	string

StoreBackupSchedule

Field	Type
`daily` always	array of integer
`monthly` always	array of integer
`weekly`	integer

StoreBackupSnapshot

Field	Type
`account_exists` always	boolean
`account_id`	string
`destination_id`	string
`format` always	string
`id` always	string
`layout` always	string
`location` always	string
`main_domain`	string
`run_id`	string
`schedule` always	string
`size_bytes` always	integer
`status` always	string
`taken_at` always	integer
`username` always	string

StoreBandwidthMonthRow

Field	Type
`account_id` always	string
`by_protocol` always	map of integer
`bytes` always	integer
`limit_mb`	integer
`main_domain` always	string
`status` always	string
`username` always	string

StoreBandwidthRow

Field	Type
`bytes_in` always	integer
`bytes_out` always	integer
`day` always	integer
`domain` always	string
`protocol` always	string

StoreCFAccount

Field	Type
`id` always	string
`name` always	string

StoreCloudflareConnection

Field	Type
`account_id` always	string
`cf_accounts` always	array of StoreCFAccount
`checked_at` always	integer
`created_at` always	integer
`created_by` always	string
`last_error`	string
`permissions` always	map of boolean
`status` always	string
`token_hint` always	string

StoreCloudflareZone

Field	Type
`account_id` always	string
`cf_status` always	string
`cf_zone_id` always	string
`created_at` always	integer
`last_error`	string
`last_plan` always	any
`last_sync_at`	integer
`name_servers` always	array of string
`purge_on_deploy` always	boolean
`ssl_strict` always	boolean
`sync_status` always	string
`zone_id` always	string
`zone_name` always	string

StoreDBAccessHost

Field	Type
`comment` always	string
`created_at` always	integer
`host` always	string
`id` always	string

StoreDBUser

Field	Type
`account_id` always	string
`auth_plugin` always	string
`created_at` always	integer
`grants` always	array of StoreDatabaseGrant
`id` always	string
`name` always	string
`updated_at` always	integer

StoreDNSRecord

Field	Type
`content` always	string
`disabled` always	boolean
`id` always	string
`managed_by` always	string
`name` always	string
`priority`	integer
`proxied`	boolean
`ttl` always	integer
`type` always	string
`zone_id` always	string

StoreDatabase

Field	Type
`account_id` always	string
`created_at` always	integer
`id` always	string
`name` always	string
`size_bytes` always	integer
`size_updated_at`	integer
`users` always	array of StoreDatabaseGrant

StoreDatabaseGrant

Field	Type
`database` always	string
`database_id` always	string
`privileges` always	array of string
`user` always	string
`user_id` always	string

StoreDelivery

Field	Type
`attempt` always	integer
`body`	string
`channel_id` always	string
`created_at` always	integer
`delivered_at`	integer
`event_type` always	string
`id` always	integer
`last_error`	string
`link`	string
`next_attempt_at` always	integer
`priority` always	string
`status` always	string
`title` always	string

StoreDeployment

Field	Type
`account_id` always	string
`activated` always	boolean
`app_id` always	string
`branch` always	string
`commit_author` always	string
`commit_message` always	string
`commit_sha` always	string
`created_at` always	integer
`created_by` always	string
`error` always	string
`finished_at`	integer
`id` always	string
`job_id` always	string
`release` always	string
`started_at`	integer
`status` always	string
`trigger` always	string

StoreDomainForward

Field	Type
`domain` always	string
`domain_id` always	string
`to_domain` always	string

StoreDomainPHPRow

Field	Type
`account_id` always	string
`domain` always	string
`domain_id` always	string
`php_version` always	string
`type` always	string
`username` always	string

StoreDomainRename

Field	Type
`from` always	string
`id` always	string
`to` always	string
`type` always	string

StoreDomainRow

Field	Type
`docroot`	string
`force_https` always	boolean
`id` always	string
`name` always	string
`parent_id`	string
`parent_name`	string
`php_version`	string
`status` always	string
`type` always	string

StoreDomainSSL

Field	Type
`autossl_excluded` always	boolean
`cert_id`	string
`domain` always	string
`domain_id` always	string
`force_https` always	boolean
`has_cert` always	boolean
`issuer`	string
`names`	array of string
`not_after`	integer
`not_before`	integer
`problem`	string
`source`	string
`type` always	string

StoreEnvVersion

Field	Type
`app_id` always	string
`created_at` always	integer
`created_by` always	string
`id` always	string

StoreErrorPageRow

Field	Type
`code` always	integer
`domain_id` always	string
`html` always	string
`updated_at` always	integer

StoreEvent

Field	Type
`account_id`	string
`created_at` always	integer
`data` always	any
`id` always	string
`seq` always	integer
`type` always	string

StoreFTPAccount

Field	Type
`account_id` always	string
`created_at` always	integer
`domain`	string
`domain_id`	string
`full_login` always	string
`has_password` always	boolean
`home_dir` always	string
`id` always	string
`kind` always	string
`login` always	string
`quota_mb`	integer
`updated_at` always	integer

StoreFeatureList

Field	Type
`accounts` always	integer
`created_at` always	integer
`id` always	string
`kind` always	string
`name` always	string
`off` always	array of string
`owner_id` always	string
`packages` always	integer
`updated_at` always	integer

StoreFilterAction

Field	Type
`dest`	string
`type` always	string

StoreFilterRule

Field	Type
`header`	string
`op` always	string
`part` always	string
`value` always	string

StoreForwarder

Field	Type
`address` always	string
`created_at` always	integer
`dest_type` always	string
`destination`	string
`domain` always	string
`domain_id` always	string
`fail_message`	string
`id` always	string
`local_part` always	string

StoreGitConnection

Field	Type
`account_id` always	string
`account_login` always	string
`account_type` always	string
`apps` always	integer
`avatar_url` always	string
`created_at` always	integer
`github_user_id` always	string
`id` always	string
`installation_id` always	integer
`nickname` always	string
`provider` always	string
`status` always	string

StoreHotlinkSettings

Field	Type
`allow_direct`	boolean
`allowed`	array of string
`enabled`	boolean
`extensions`	array of string
`redirect`	string

StoreIPAddress

Field	Type
`account_id`	string
`accounts` always	integer
`address` always	string
`created_at` always	integer
`family` always	integer
`id` always	string
`interface`	string
`kind` always	string
`nat_public`	string
`prefix_len` always	integer
`username`	string

StoreIPBlock

Field	Type
`cidrs` always	array of string
`entry` always	string

StoreIPChoice

Field	Type
`accounts` always	integer
`address` always	string
`free` always	boolean
`id` always	string
`kind` always	string
`owner`	string

StoreIncident

Field	Type
`account_id` always	string
`action` always	string
`details` always	map of any
`detected_at` always	integer
`id` always	string
`kind` always	string
`resolved_at`	integer
`resolved_by`	string
`username` always	string

StoreIndexSetting

Field	Type
`mode`	string
`path`	string

StoreIsolation

Field	Type
`cpu_pct`	integer
`ep`	integer
`inodes`	integer
`io_mbps`	integer
`iops`	integer
`mem_mb`	integer
`nproc`	integer

StoreJob

Field	Type
`account_id`	string
`attempts` always	integer
`created_at` always	integer
`error`	string
`finished_at`	integer
`id` always	string
`kind` always	string
`max_attempts` always	integer
`payload` always	any
`progress_pct` always	integer
`started_at`	integer
`status` always	string

StoreJobLog

Field	Type
`at` always	integer
`level` always	string
`message` always	string

StoreJobRun

Field	Type
`account_id`	string
`attempts`	integer
`created_at`	integer
`error`	string
`finished_at`	integer
`id`	string
`kind`	string
`max_attempts`	integer
`payload`	any
`progress_pct`	integer
`started_at`	integer
`status`	string
`username`	string

StoreLoginAttempt

Field	Type
`at` always	integer
`ip` always	string
`reason`	string
`service` always	string
`success` always	boolean
`username`	string

StoreMailAccount

Field	Type
`account_id` always	string
`address` always	string
`autoresponder` always	boolean
`created_at` always	integer
`domain` always	string
`domain_id` always	string
`filters_count` always	integer
`id` always	string
`is_system` always	boolean
`local_part` always	string
`login_state` always	string
`quota_mb`	integer
`receive_state` always	string
`send_state` always	string
`used_bytes` always	integer
`used_updated_at`	integer

StoreMailDelivery

Field	Type
`account_id`	string
`at` always	integer
`auth_user` always	string
`detail`	string
`event` always	string
`host` always	string
`id` always	integer
`message_id` always	string
`recipient` always	string
`sender` always	string
`server`	string
`size_bytes` always	integer
`username`	string

StoreMailRoutingRow

Field	Type
`account_id` always	string
`domain` always	string
`domain_id` always	string
`routing` always	string
`type` always	string
`username` always	string

StoreNameChange

Field	Type
`from` always	string
`kind` always	string
`to` always	string

StoreNode

Field	Type
`accounts` always	integer
`address` always	string
`created_at` always	integer
`fingerprint` always	string
`hostname` always	string
`id` always	string
`is_default` always	boolean
`last_error`	string
`last_seen_at`	integer
`name` always	string
`os`	string
`public_ip` always	string
`role` always	string
`status` always	string
`tunnel_index` always	integer
`version`	string

StoreNotification

Field	Type
`body`	string
`created_at` always	integer
`event_type` always	string
`id` always	string
`link`	string
`priority` always	string
`read_at`	integer
`title` always	string

StorePackage

Field	Type
`account_count` always	integer
`bw_limit_mb`	integer
`cgi` always	boolean
`created_at` always	integer
`dedicated_ip` always	boolean
`default_email_quota_mb`	integer
`digest_auth` always	boolean
`disk_quota_mb`	integer
`feature_list_id` always	string
`feature_list_name` always	string
`id` always	string
`isolation` always	StoreIsolation
`locale` always	string
`max_addon`	integer
`max_email`	integer
`max_email_per_hour`	integer
`max_email_quota_mb`	integer
`max_ftp`	integer
`max_parked`	integer
`max_sql`	integer
`max_sub`	integer
`name` always	string
`owner` always	string
`owner_id` always	string
`php_max_children`	integer
`shell` always	string
`theme` always	string
`updated_at` always	integer

StoreProtectedDir

Field	Type
`account_id` always	string
`created_at` always	integer
`id` always	string
`path` always	string
`realm` always	string
`updated_at` always	integer
`users` always	array of StoreProtectedUser

StoreProtectedUser

Field	Type
`created_at` always	integer
`username` always	string

StoreRedirectRow

Field	Type
`code` always	integer
`created_at` always	integer
`domain` always	string
`domain_id` always	string
`id` always	string
`path` always	string
`target_url` always	string
`wildcard` always	boolean
`www_mode` always	string

StoreReseller

Field	Type
`account_status` always	string
`acl_list_id` always	string
`acl_list_name` always	string
`bw_limit_mb`	integer
`contact_email` always	string
`created_at` always	integer
`disk_limit_mb`	integer
`id` always	string
`main_domain` always	string
`max_accounts`	integer
`nameservers` always	array of string
`oversell_bw` always	boolean
`oversell_disk` always	boolean
`owns_itself` always	boolean
`panel_hostname` always	string
`suspend_reason`	string
`suspended_at`	integer
`usage` always	StoreResellerUsage
`username` always	string

StoreResellerUsage

Field	Type
`accounts` always	integer
`bw_allocated_mb` always	integer
`bw_unlimited_accounts` always	integer
`bw_used_mb` always	integer
`disk_allocated_mb` always	integer
`disk_unlimited_accounts` always	integer
`disk_used_mb` always	integer
`suspended` always	integer

StoreRestoreJob

Field	Type
`account_id`	string
`created_at` always	integer
`created_by` always	string
`finished_at`	integer
`id` always	string
`job_id`	string
`mode` always	string
`progress` always	integer
`snapshot_id`	string
`source` always	string
`started_at`	integer
`status` always	string
`target_username` always	string

StoreSPFCustom

Field	Type
`all`	string
`hosts`	array of string
`includes`	array of string
`ip4`	array of string
`ip6`	array of string

StoreSSLCSR

Field	Type
`created_at` always	integer
`domains` always	array of string
`friendly_name` always	string
`id` always	string
`key_id` always	string
`pem` always	string
`subject` always	map of string

StoreSSLCert

Field	Type
`chain_pem`	string
`created_at` always	integer
`domains` always	array of string
`friendly_name` always	string
`id` always	string
`installed_on` always	array of string
`issuer` always	string
`key_id`	string
`not_after` always	integer
`not_before` always	integer
`pem`	string
`serial` always	string
`sha256` always	string
`source` always	string
`validation` always	string

StoreSSLKey

Field	Type
`cert_count` always	integer
`created_at` always	integer
`csr_count` always	integer
`friendly_name` always	string
`id` always	string
`key_type` always	string
`pub_sha256` always	string

StoreSenderVolume

Field	Type
`account_id` always	string
`deferred` always	integer
`failed` always	integer
`max_email_per_hour`	integer
`messages` always	integer
`unique_recipients` always	integer
`username` always	string

StoreServerDomain

Field	Type
`account_id` always	string
`docroot`	string
`force_https`	boolean
`id`	string
`name`	string
`parent_id`	string
`parent_name`	string
`php_version`	string
`status`	string
`type`	string
`username` always	string

StoreSetupState

Field	Type
`completed` always	boolean
`contact_email` always	string
`hostname` always	string
`license_status` always	string
`main_ipv4` always	string
`nameservers` always	array of string
`terms_accepted` always	boolean
`trial_ends_at`	integer

StoreSpamSettings

Field	Type
`allow_list`	array of string
`auto_delete`	boolean
`auto_delete_threshold`	number
`block_list`	array of string
`enabled`	boolean
`spam_box`	boolean
`subject_prefix`	string
`tag_subject`	boolean
`threshold`	number
`updated_at`	integer

StoreTransferSession

Field	Type
`auth_method` always	string
`created_at` always	integer
`finished_at`	integer
`host_key_sha256`	string
`id` always	string
`initiator` always	string
`last_activity_at` always	integer
`options` always	any
`remote_analysis`	any
`source_host` always	string
`source_port` always	integer
`source_type` always	string
`state` always	string

StoreUsageSample

Field	Type
`at` always	integer
`cpu_throttled_usec` always	integer
`cpu_usec` always	integer
`ep_peak` always	integer
`faults_cpu` always	integer
`faults_ep` always	integer
`faults_io` always	integer
`faults_mem` always	integer
`faults_nproc` always	integer
`io_pressure_avg` always	number
`io_read_bytes` always	integer
`io_read_ops` always	integer
`io_write_bytes` always	integer
`io_write_ops` always	integer
`mem_avg_bytes` always	integer
`mem_peak_bytes` always	integer
`nproc_peak` always	integer

StoreVhostCert

Field	Type
`account_id` always	string
`account_status` always	string
`autossl_excluded`	boolean
`cert_id`	string
`domain`	string
`domain_id`	string
`force_https`	boolean
`has_cert`	boolean
`issuer`	string
`key_type`	string
`names`	array of string
`not_after`	integer
`not_before`	integer
`problem`	string
`source`	string
`type`	string
`username` always	string

StoreWebOptions

Field	Type
`hotlink` always	StoreHotlinkSettings
`indexes` always	array of StoreIndexSetting
`ip_blocks` always	array of StoreIPBlock

StoreWebhookDelivery

Field	Type
`attempts` always	integer
`created_at` always	integer
`delivered_at`	integer
`endpoint_id` always	string
`event_id` always	string
`event_type` always	string
`http_status`	integer
`id` always	integer
`next_attempt_at`	integer
`response`	string
`status` always	string

StoreWebhookEndpoint

Field	Type
`account_id`	string
`consecutive_failures` always	integer
`created_at` always	integer
`description` always	string
`disabled_reason`	string
`enabled` always	boolean
`events` always	array of string
`id` always	string
`owner_type` always	string
`updated_at` always	integer
`url` always	string

StoreZone

Field	Type
`account_id` always	string
`default_ttl` always	integer
`id` always	string
`name` always	string
`serial` always	integer

StoreZoneInfo

Field	Type
`account_id`	string
`account_status`	string
`default_ttl`	integer
`domain_id`	string
`id`	string
`name`	string
`published` always	boolean
`published_at`	integer
`record_count` always	integer
`serial`	integer
`soa` always	StoreZoneSOA
`template_id`	string
`updated_at` always	integer
`username`	string

StoreZoneSOA

Field	Type
`expire` always	integer
`minimum` always	integer
`mname` always	string
`refresh` always	integer
`retry` always	integer
`rname` always	string
`ttl` always	integer

StoreZoneTemplate

Field	Type
`body` always	string
`builtin` always	boolean
`id` always	string
`name` always	string
`updated_at` always	integer

TokenReq

Field	Type
`allowed_ips`	array of string
`expires_at`	integer
`name`	string
`scopes`	array of string

TokenScope

Field	Type
`key` always	string
`label` always	string

TweakItem

Field	Type
`category`	string
`default`	any
`help`	string
`is_default` always	boolean
`key`	string
`keywords`	array of string
`label`	string
`linked`	string
`max`	integer
`max_length`	integer
`min`	integer
`options`	array of SettingsOption
`type`	string
`unit`	string
`updated_at`	integer
`updated_by`	string
`value` always	any

UpdateConfig

Field	Type
`auto` always	boolean
`channel` always	string
`os` always	boolean
`url` always	string

UpdateMailReq

Field	Type
`login_state`	string
`quota_mb`	integer
`receive_state`	string
`send_state`	string
`unlimited`	boolean

UpdateManifest

Field	Type
`build` always	integer
`channel` always	string
`notes`	string
`package` always	string
`released_at` always	integer
`sha256` always	string
`size` always	integer
`version` always	string

UpdateOSPackage

Field	Type
`from`	string
`name` always	string
`to` always	string

UpdateOSResult

Field	Type
`changed` always	array of UpdateOSPackage
`errors`	array of string
`finished_at` always	integer
`reboot_required` always	boolean
`restart_pending` always	array of string
`restarted` always	array of string
`started_at` always	integer
`steps`	array of UpdateOSStep

UpdateOSStep

Field	Type
`command` always	string
`ok` always	boolean
`output`	string

UpdateResult

Field	Type
`finished_at` always	integer
`message` always	string
`status` always	string
`version` always	string

UsageItem

Field	Type
`feature`	string
`key` always	string
`label` always	string
`limit`	integer
`unit` always	string
`used` always	integer

UserRow

Field	Type
`account_id`	string
`hosts` always	array of string
`plugin` always	string
`system` always	boolean
`user` always	string
`username`	string

UserSessionResp

Field	Type
`account`	map of string
`authenticated` always	boolean
`csrf_token`	string
`expires_at`	integer
`features`	array of string
`impersonated` always	boolean
`mfa_required` always	boolean
`nameservers`	array of string
`read_only` always	boolean
`reseller` always	boolean
`two_factor_setup_required` always	boolean

UserView

Field	Type
`account_id`	string
`avatar_url`	string
`created_at`	integer
`gh_user_id`	integer
`id`	string
`installations` always	array of StoreGitConnection
`login`	string
`nickname`	string

VerRow

Field	Type
`default` always	boolean
`domains` always	integer
`version` always	string

Visitor

Field	Type
`bytes` always	integer
`ip` always	string
`referer` always	string
`request` always	string
`status` always	integer
`time` always	string
`user_agent` always	string

WebDirective

Field	Type
`basic` always	boolean
`default` always	string
`help` always	string
`max`	integer
`min`	integer
`name` always	string
`options`	array of string
`type` always	string

WebhookReq

Field	Type
`description`	string
`enabled`	boolean
`events`	array of string
`url`	string

WebhooksEventType

Field	Type
`account` always	boolean
`description` always	string
`type` always	string

Schemas

#ACLKey

#AcctPrefs

#AdminBrandingView

#AgentprotoDiskUsage

#AgentprotoProcess

#AgentprotoServiceStatus

#AgentprotoSystemStats

#AlertView

#AppView

#BlockView

#BrandingColors

#BrandingContact

#BrandingInput

#BrandingLink

#BrandingView

#CertPreview

#CertReq

#ChannelReq

#ChannelView

#ClientSettings

#CloudflareConflict

#CloudflarePlan

#CloudflareRecord

#CloudflareWant

#CreateAccountReq

#CreateForwarderReq

#CreateMailReq

#DbRow

#DefaultAddressView

#DestReq

#DomainSSLView

#DomainView

#Entry

#FeaturesFeature

#FsResult

#FtpInput

#FtpItem

#FwRuleView

#GithubRepo

#GlobalcfgMail

#GlobalcfgSmarthost

#GlobalcfgWeb

#HostingAccountSettings

#HostingAppInput

#HostingCFDomain

#HostingCFOverview

#HostingCFPreview

#HostingCSRSubject

#HostingDeliverabilityReport

#HostingDestConfig

#HostingDomainInput

#HostingDomainPlan

#HostingExportedFilter

#HostingFTPSession

#HostingFiltersExport

#HostingGitHubAppView

#HostingHostnameReport

#HostingImportDecisions

#HostingImportResult

#HostingLogSettings

#HostingMXEntry

#HostingMailAdminSettings

#HostingMassMail

#HostingOSUpdateOverview

#HostingOSUpdateServer

#HostingPlanCheck

#HostingRecordCheck

#HostingRecordInput

#HostingRemoteAccount

#HostingRemoteAnalysis

#HostingRenamePlan

#HostingRestoreOptions

#HostingSSLSettings

#HostingValkeyView

#HostingWorkerOptions

#ImportReq

#Item

#LicenseInfo

#LimitView

ACLKey

AcctPrefs

AdminBrandingView

AgentprotoDiskUsage

AgentprotoProcess

AgentprotoServiceStatus

AgentprotoSystemStats

AlertView

AppView

BlockView

BrandingColors

BrandingContact

BrandingInput

BrandingLink

BrandingView

CertPreview

CertReq

ChannelReq

ChannelView

ClientSettings

CloudflareConflict

CloudflarePlan

CloudflareRecord

CloudflareWant

CreateAccountReq

CreateForwarderReq

CreateMailReq

DbRow

DefaultAddressView

DestReq

DomainSSLView

DomainView

Entry

FeaturesFeature

FsResult

FtpInput

FtpItem

FwRuleView

GithubRepo

GlobalcfgMail

GlobalcfgSmarthost

GlobalcfgWeb

HostingAccountSettings

HostingAppInput

HostingCFDomain

HostingCFOverview

HostingCFPreview

HostingCSRSubject

HostingDeliverabilityReport

HostingDestConfig

HostingDomainInput

HostingDomainPlan

HostingExportedFilter

HostingFTPSession

HostingFiltersExport

HostingGitHubAppView

HostingHostnameReport

HostingImportDecisions

HostingImportResult

HostingLogSettings

HostingMXEntry

HostingMailAdminSettings

HostingMassMail

HostingOSUpdateOverview

HostingOSUpdateServer

HostingPlanCheck

HostingRecordCheck

HostingRecordInput

HostingRemoteAccount

HostingRemoteAnalysis

HostingRenamePlan

HostingRestoreOptions

HostingSSLSettings

HostingValkeyView

HostingWorkerOptions

ImportReq

Item

LicenseInfo

LimitView

LoginReq