Page tree
Skip to end of metadata
Go to start of metadata

Description

This function determines whether to enable PHP-FPM on new accounts and domains on a server. 

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/php_set_default_accounts_to_fpm?api.version=1&default_accounts_to_fpm=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/php_set_default_accounts_to_fpm?api.version=1&default_accounts_to_fpm=1
 Command Line
whmapi1 php_set_default_accounts_to_fpm default_accounts_to_fpm=1


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "metadata" : {
      "version" : 1,
      "result" : 1,
      "command" : "php_set_default_accounts_to_fpm",
      "reason" : "OK"
   },
   "data" : {}
}
 Output (XML)
<xml>
  <data></data>
  <metadata>
    <command>php_set_default_accounts_to_fpm</command>
    <reason>OK</reason>
    <result>1</result>
    <version>1</version>
  </metadata>
</xml>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.


Parameters

ParameterTypeDescriptionPossible ValuesExample
default_accounts_to_fpmBoolean

Whether to enable PHP-FPM on all new accounts and domains on a server.

  • 1 — Enable PHP-FPM.
  • 0 — Disable PHP-FPM.
1


Returns

This function returns only metadata.