file/addftpaccount
Description
Creates a new FTP account in a given SPanel user account.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| token | string | Yes | Authorizing API token – check API Basics for more information. |
| accountuser | string | Yes | The SPanel user account that is being managed or viewed. |
| action | string | Yes | The category and function being executed. |
| username | string | Yes | The FTP username to be created. |
| path | string | No | The new FTP user’s home path, relative to the SPanel user’s home directory, e.g. /home/spanelio/new_user_path. If left empty the newly created user will have full access to the SPanel user’s home directory. |
| password | string | Yes | The new FTP user’s password. |
Example
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
$postData = [
'token' => 'provided_auth_token',
'accountuser' => 'spanelio',
'action' => 'file/addftpaccount',
'username' => 'newftpuser',
'path' => '',
'password' => 'KExk80Ml5aG6M'
];
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );You can find more information about the Endpoint URL in our API Basics article.
Output
{
"result": "success",
"data": {
"msg": "Successfully created FTP user spanelio_newftpuser"
}
}