v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Ftp

FTP Accounts

Return FTP accounts

This function lists FTP account information.

Important:

When you disable the FTP role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

get/Ftp/list_ftp

Query parameters

include_acct_typesstring

Example:main|anonymous

A list of the FTP account types to include in the function's results.

anonymous
logaccess
main
sub

If you do not specify this parameter, this function returns all FTP account types.

Note:

Separate multiple types with the pipe character (|).
In browser-based calls, use %7C.

skip_acct_typesstring

Example:main|anonymous

A list of the FTP account types to exclude from the function's results.

anonymous
logaccess
main
sub

If you do not specify this parameter, this function does not exclude any account types.

Note:

Separate multiple types with the pipe character (|).
In browser-based calls, use %7C.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_ftp",
  "module": "Ftp",
  "result": {
    "data": [
      {
        "homedir": "/home/user/public_html/ftp/",
        "type": "main",
        "user": "ftpaccount"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}