Child pages
  • WHM API 1 Functions - is_conversion_in_progress
Skip to end of metadata
Go to start of metadata

Description

This function indicates whether the system's process to convert all of WHM's accounts to use PHP-FPM is in progress.


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.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


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


Notes:

  • 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)
{
   "data" : {
      "inProgress" : 0
   },
   "metadata" : {
      "result" : 1,
      "reason" : "OK",
      "version" : 1,
      "command" : "is_conversion_in_progress"
   }
}
 Output (XML)
<result>
  <data>
    <inProgress>0</inProgress>
  </data>
  <metadata>
    <command>is_conversion_in_progress</command>
    <reason>OK</reason>
    <result>1</result>
    <version>1</version>
  </metadata>
</result>


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
inProgressBooleanWhether the system's process to convert all of WHM's accounts to use PHP-FPM is in progress.
  • 1 — In progress.
  • 0Not currently in progress.
1