WHM API 1 Functions - php_set_session_save_path

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/php_set_session_save_path?api.version=1&path=%2Fvar%2Fcpanel%2Fphp%2Fsessions&overwrite=1

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/php_set_session_save_path?api.version=1&path=%2Fvar%2Fcpanel%2Fphp%2Fsessions&overwrite=1

Command Line

whmapi1 php_set_session_save_path path=%2Fvar%2Fcpanel%2Fphp%2Fsessions overwrite=1

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" : {
      "version" : 1,
      "result" : 1,
      "command" : "php_set_session_save_path",
      "reason" : "OK"
   },
   "data" : {}
}

Output (XML)

<xml>
  <data></data>
  <metadata>
    <command>php_set_session_save_path</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

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 /tmp or another insecure location.

This parameter defaults to /var/cpanel/php/sessions.

A valid absolute directory path.

/var/cpanel/php/sessions

overwrite

Boolean

Whether to overwrite the existing session save path in the php.ini file.

This parameter defaults to 0.

1 — Overwrite the existing value in the php.ini file.
0 — Do not overwrite the existing value in the php.ini file.

0

Returns

This function returns only metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 66+

Methods:

GET, POST

Required Parameters:

(none)

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

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.

Child pages