- Created by Documentation, last modified on Oct 05, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function sets the location of PHP's default session save path.
Important:
WebServer
role, the system disables this function. For more information, read our How to Use Server Profiles documentation.Examples
https://hostname.example.com:2087/cpsess##########/json-api/php_set_session_save_path?api.version=1&path=%2Fvar%2Fcpanel%2Fphp%2Fsessions&overwrite=1
https://hostname.example.com:2087/cpsess##########/xml-api/php_set_session_save_path?api.version=1&path=%2Fvar%2Fcpanel%2Fphp%2Fsessions&overwrite=1
whmapi1 php_set_session_save_path path=%2Fvar%2Fcpanel%2Fphp%2Fsessions overwrite=1
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
{ "metadata" : { "version" : 1, "result" : 1, "command" : "php_set_session_save_path", "reason" : "OK" }, "data" : {} }
<xml> <data></data> <metadata> <command>php_set_session_save_path</command> <reason>OK</reason> <result>1</result> <version>1</version> </metadata> </xml>
Note:
Parameters
Parameter | Type | Description | Possible Values | Example |
---|---|---|---|---|
path | string | The directory in which to save session information. Warning: For security reasons, do not set this value to This parameter defaults to | A valid absolute directory path. | /var/cpanel/php/sessions |
overwrite | Boolean | Whether to overwrite the existing session save path in the This parameter defaults to |
| 0 |
Returns
This function returns only metadata.
Function information
API Version:
Available in:
WHM 66+
Methods:
GET, POST
Required Parameters:
Return Formats:
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
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:cPanel API 1 Functions - LastLogin::lastlogin — This function retrieves the IP address of the last user to successfully log in to the cPanel account.
-
Page:cPanel API 1 Functions - OptimizeWS::optimizews — This function configures a cPanel account's
mod_deflate
setting. -
Page:cPanel API 2 Functions - ForcePassword::get_force_password_flags — This function is deprecated and does not return useful output.
-
Page:cPanel API 2 Functions - ForcePassword::update_force_password_flags — This function is deprecated and does not return useful output.
-
Page:cPanel API 2 Functions - Passwd::change_password — This function changes a cPanel account's password.