Self Help Documentation
< All Topics

file/removeftpaccount

PostedFebruary 24, 2022
UpdatedApril 25, 2023

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

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
usernamestring|arrayYesThe 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

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$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 );

You can find more information about the Endpoint URL in our API Basics article.

Output

JSON
PHP
1
2
3
4
5
6
{
    "result": "success",
    "data": {
        "msg": false
    }
}
Table of Contents