Return PHP-FPM directives and pool options

This function retrieves the PHP INI directives and pool options for a system's or domain's PHP-FPM configuration.

Important:

When you disable the WebServer role, the system disables this function.

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.

SecurityBasicAuth

Request

Request Body schema: application/json
required

domain

string

Default: ""

A blank value or domain name whose PHP-FPM configuration you wish to retrieve.

A valid domain that resides on the local server — Retrieves the domain's PHP-FPM configuration information.
A blank value — Retrieves the system's PHP-FPM information.

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

post/php_fpm_config_get

Request samples

Payload
CLI
HTTP Request (Wire Format)

application/json

{"domain": "example.com"
}

Response samples

application/json

{"data": {"config": [{"base_flag_name": "short_open_tag",
"trinary_admin_value": 1,
"value": "on"
},
{"base_flag_name": "log_errors",
"trinary_admin_value": 1,
"value": "on"
},
{"base_flag_name": "pm_process_idle_timeout",
"trinary_admin_value": 0,
"value": "10"
},
{"base_flag_name": "error_reporting",
"trinary_admin_value": 2,
"value": "E_ALL & ~E_NOTICE"
},
{"base_flag_name": "disable_functions",
"trinary_admin_value": 1,
"value": "exec,passthru,shell_exec,system"
},
{"base_flag_name": "error_log",
"trinary_admin_value": 1,
"value": "[% homedir %]/logs/[% scrubbed_domain %].php.error.log"
},
{"base_flag_name": "pm_max_children",
"trinary_admin_value": 0,
"value": "5"
},
{"base_flag_name": "pm_max_requests",
"trinary_admin_value": 0,
"value": "20"
},
{"base_flag_name": "allow_url_fopen",
"trinary_admin_value": 1,
"value": "on"
},
{"base_flag_name": "doc_root",
"trinary_admin_value": 1,
"value": "[% documentroot %]"
}
]
},
"metadata": {"command": "php_fpm_config_get",
"reason": "OK",
"result": 1,
"version": 1
}
}