Developer Documentation
Child pages
  • WHM API 1 Functions - php_ini_get_content
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Use WHM API to Call cPanel API & UAPI

 

 

Description

This function returns the contents of a PHP version's php.ini file.


Note:

This document only applies to systems that run EasyApache 4.


Examples 

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


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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
 {
   "data":{
      "content":"display_errors\n;   Default Value: On\n;   Development Value: On\n;   
       Production Value: Off\n\n; display_startup_errors\n;   Default Value: Off\n;   Development Value: On\n;   Production Value: Off\n\n; ; End:"
   },
   "metadata":{
      "version":1,
      "reason":"Ok",
      "result":1,
      "command":"php_ini_get_content"
   }
}
 Output (XML)
 <result>
    <data>
        <content>
            display_errors ; Default Value: On ; Development Value: On ; Production Value: Off ; display_startup_errors ; Default Value: Off ; Development Value: On ; Production Value: Off ; End:
        </content>
    </data>
    <metadata>
        <version>1</version>
        <reason>Ok</reason>
        <result>1</result>
        <command>php_ini_get_content</command>
    </metadata>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample

version

string

Required

An installed PHP version.

  • ea-php54
  • ea-php55
  • ea-php56
  • ea-php70
  • ea-php71
  • ea-php72
  • Any custom PHP package name.
 ea-php54

Returns

ReturnTypeDescriptionPossible valuesExample

content

stringThe contents of the requested PHP version's php.ini file.

A list of PHP directives.

 Click to view...
display_errors\n; Default Value: On\n; Development Value: On\n; Production Value: Off\n\n;

 


Function information

API Version:

WHM API 1

Available in:

WHM 11.52+

Methods:

GET, POST

Required Parameters:

version

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions