cPanel module
StatsBar
1 functions, invoked through the cpanel_uapi tool.
scope cpanel:uapi
Call any function with
cpanel_uapi(service_id, module="StatsBar", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.get_stats GET#
Return cPanel account statistics
This function retrieves a cPanel account's statistics.
displaystringRequired
A pipe-delimited list of the account's statistics. <details> <summary>Click for a list of available display parameters.</summary> addondomains — Information about the account's addon domains. apacheversion — The server's Apache version. autoresponders — Information about the account's auto-responders. bandwidthusage — Information about the account's bandwidth usage. cachedlistdiskusage — The amount of cached mailing list disk space the account currently uses. cachedmysqldiskusage — The amount of cached disk space that the account's MySQL® databases currently use. cachedpostgresdiskusage — The amount of cached disk space that the account's PostgreSQL databases use. cpanelversion — The server's cPanel version. dedicatedip — Account websites that use dedicated IP addresses. diskusage — Information the account's disk space usage. emailaccounts — Information about the account's email accounts. emailfilters — Information the account's email filters. emailforwarders — Information about the account's forwarders. fileusage — Information about the account's file usage. ftpaccounts — Information about the account's FTP accounts. hostingpackage — The account's hosting package. hostname — The server's hostname. kernelversion — The operating system's kernel version. localip — Account websites that use local IP addresses. machinetype — The type of operating system that the server uses. mailinglists — Information the account's mailing lists. mysqldatabases — The number of MySQL databases the account possesses. mysqldiskusage — The amount of disk space that the account's MySQL databases use. mysqlversion — The server's MySQL version. operatingsystem — The server's operating system. parkeddomains — Information about the account's parked domains (aliases). perlpath — The Perl binary's absolute path. perlversion — The server's Perl version. phpversion — The server's PHP version. postgresqldatabases — The number of PostgreSQL databases the cPanel account possesses. postgresdiskusage — The amount of disk space that the cPanel account's PostgreSQL databases use. sendmailpath — The path to the system's sendmail binary. sharedip — Any of the account's websites that use a shared IP address. shorthostname — The short version of your server's hostname. sqldatabases — Information about the all of the account's SQL databases. subdomains — Information about the account's subdomains. theme — The account's current theme. </details> Note: This function may require URI-encode format (%7C) or quotes (") in some contexts, such as the command line tool. * Some display parameters may be unavailable based on the server's configuration.
infinityimgstringOptional
The absolute file path to an alternative infinity symbol image.
infinitylangstringOptional
A phrase to represent infinity that the locales system can use.
rowcounterstringOptional
The type of row. odd even
warninglevelintegerOptional
The minimum level at which to return warnings.
warningsintegerOptional
Whether to return all results with a warning. 1 — Return only warnings that exceed the warninglevel parameter's value. 0 — Return all results.
warnoutintegerOptional
Whether to display results with a value of 100%. 1 — Display results with a value of 100%. 0 — Hide results with a value of 100%.
Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:
_countstring
The queried data's value.
_maxstring
The queried parameter's limit.
_maxedinteger
Whether the queried value reached its maximum value. 1 — Reached maximum value. 0 — Has not reached maximum value.
One of: 1 0
conditioninteger
Whether the queried data's value possesses a conditional requirement. 1 — Possesses a condition. 0 — Does not possess a condition. Note: The function will only return this value if it determines that the related statistic meets the subsystem installation requirements.
One of: 1 0
countstring
The queried data's value.
featurestring
The queried item's feature name.
idstring
The queried item's reference name.
is_maxedinteger
Whether the queried value has reached its maximum value. 1 — The queried value has reached its maximum value. 0 — The queried value has not reached its maximum value.
One of: 1 0
itemstring
A human-readable version of the queried item.
maxstring
The queried value's maximum limit.
maxed_phrasestring
The maketext-formatted message that the interface displays when the user reaches their maximum allowed value.
modulestring
The module that retrieved the information.
namestring
The display key.
near_limit_phrasestring
The maketext-formatted message that the interface displays when the user approaches their maximum allowed value.
normalizedinteger
Whether the function normalized the output values. 1 — Normalized. 0 — Did not normalize.
One of: 1 0
percentinteger
The percentage of value, if applicable.
percent10integer
The percentage of value that the system rounds to the nearest ten, if applicable.
percent20integer
The percentage of value that the system rounds to the nearest twenty, if applicable.
percent5integer
The percentage of value that the system rounds to the nearest five, if applicable.
phrasestring
The human-readable name of the queried item.
rolestring
The queried value's role. CalendarContact DNS FileStorage FTP MailLocal MailReceive MailSend MySQL Postgres SpamFilter Webmail WebDisk * WebServer
One of: CalendarContact DNS FileStorage FTP MailLocal MailReceive MailSend MySQL Postgres SpamFilter Webmail WebDisk
rowtypestring
The queried value's row type. even odd
One of: even odd
unitsstring
The queried value's unit of measure.
zeroisunlimitedinteger
Whether a value of 0 means unlimited or zero. 1 — Unlimited. 0 — Zero.
One of: 1 0