pem.ProFTPD.getCustomFTPUsersList

This method is supported by Operations starting from version 2.9 HOTFIX01.

This method returns the list of the existing Custom FTP Users for the specified Webspace.

The method has the following input parameters:

Name

Type

Short Description

webspace_id

int

Webspace ID

The method returns the array of structures:

Name

Type

Short Description

webspace_id

int

Webspace ID

login_suffix

string

Login suffix of Custom FTP User

login

string

Login of Custom FTP User

location

struct

It represents the entry point for Custom FTP User.

  • location_base

string

It represents a base location. There are the following options:

  • httpdocs – WebSite document root (/webspace/httpdocs).
  • httpsdocs – SSL WebSite document root (/webspace/httpsdocs).
  • cgi-bin – WebSite CGI directory (/webspace/cgi-bin).
  • [path]

string

Path inside the base location

ip_address

string

FTP Server IP Address

portnum

int

FTP Server port number