Manual
Beget.API
Beget.API
FTP administration functions

FTP administration functions

getList

Description:

Method returns list of additional FTP accounts with their home directories.

Call example:
https://api.beget.de/api/ftp/getList?login=userlogin&
passwd=password&output_format=json
Response example:
[
   {
      "login":"user_acc1",
      "homedir":"\/public_html"
   },
   {
      "login":"user_siteru",
      "homedir":"\/site.de\/public_html"
   }
]

add

Description:

Method adds new FTP account.

Additional parameters
  • suffix - suffix part of login. When passing this parameter, please note that the final login in form of "login_suffix" must not exceed 17 characters;
  • homedir - path to home directory of created account. Begins with a slash. (e.g. /site.de/public_html);
  • password - password for new ftp account;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/ftp/add?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"suffix":"ftp1","homedir":"/site.de/public_html","password":"password"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/ftp/add?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22suffix%22%3A%22ftp1%22%2C%22homedir%22
%3A%22%2Fsite.de%2Fpublic_html%22%2C%22password%22%3A%22password%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

changePassword

Description:

Method performs password change for additional FTP account.

Additional parameters
  • suffix - suffix part of login. When passing this parameter, please note that the final login in form of "login_suffix" must not exceed 17 characters.;
  • password - password for new ftp account;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/ftp/changePassword?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"suffix":"ftp1","password":"newpassword"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/ftp/changePassword?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22suffix%22%3A%22ftp1%22%2C%22password
%22%3A%22newpassword%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

delete

Description:

Method deletes additional FTP account with given suffix.

Additional parameters
  • suffix - suffix part of login. When passing this parameter, please note that the final login in form of "login_suffix" must not exceed 17 characters.;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/ftp/delete?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"suffix":"ftp1"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/ftp/delete?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22suffix%22%3A%22ftp1%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

Tags:

API