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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 

Description

This function activates PHP-FPM for any non-PHP-FPM domains on a server. 

 

Examples


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


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" :    
        "command" : "convert_all_domains_to_fpm" ,
        "result" : 1 ,
        "reason" : "OK" ,
        "version" : 1
    } ,
    "data" :    
        "build" : "1493645120"
    }
}

 Output (XML)
<xml>
    <data>
        <build>1493645238</build>
    </data>
    <metadata>
        <command>convert_all_domains_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

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible ValuesExample
build_id integer

The ID of the log file for the conversion process.

A valid value.

1493645269

  • No labels