You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

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

Description

This function determines whether your system runs with a preconfigured PHP-FPM configuration.

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.

Examples


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


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)
{  
   "data":{  
      "old_fpm_flag":2
   },
   "metadata":{  
      "version":1,
      "command":"php_get_old_fpm_flag",
      "result":1,
      "reason":"OK"
   }
}
 Output (XML)
<result>
    <metadata>
        <command>php_get_old_fpm_flag</command>
        <version>1</version>
        <result>1</result>
        <reason>OK</reason>
    </metadata>
    <data>
        <old_fpm_flag>2</old_fpm_flag>
    </data>
</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

old_fpm_flag

integer

The status of the preconfigured FPM.

    • 0 — No preconfigured FPM exists.
    • 1 — Preconfigured FPM exists.
    • 2 — Preconfiguration dialogue dismissed.

2