Self Help Documentation
file/removeftpaccount
Description
Removes an existing FTP account from the selected SPanel user account. The files inside the FTP accout’s home directory remain intact and must be deleted manually.
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|array | Yes | The FTP account name to remove. An array with multiple FTP accounts is supported as well. The FTP account name is accepted with or without the SPanel user account prefix, in both cases. |
Example
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
$postData = [
'token' => 'provided_auth_token',
'accountuser' => 'spanelio',
'action' => 'file/removeftpaccount',
'domain' => 'newftpuser',
//'domain' => ['newftpuser', 'spanelio_newftpuser2'],
];
$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 );
Code language: PHP (php)
You can find more information about the Endpoint URL in our API Basics article.
Output
{
"result": "success",
"data": {
"msg": false
}
}
Code language: JSON / JSON with Comments (json)