Return workload data for PHP-FPM on all domains

This function provides information that will help you to determine whether your server can handle the workload if you enable PHP-FPM for all domains.

Important:

When you disable the Web Server role, the system disables this function.

Warning:

We strongly recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  get_fpm_count_and_utilization

Response samples

Content type
application/json
{
  • "data": {
    • "domains_to_be_enabled": 2,
    • "domains_using_fpm": 20,
    • "memory_needed": 90000,
    • "number_of_new_fpm_accounts_we_can_handle": 8,
    • "show_warning": 0,
    • "total_domains": 22
    },
  • "metadata": {
    • "command": "get_fpm_count_and_utilization",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}