UAPI Functions - Ftp::get_ftp_daemon_info - Knowledgebase

Description

This function retrieves the extended information about the server's FTP daemon.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_ftp_daemon_info

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve extended information about the FTP server.

$ftp_server = $cpanel->uapi(

'Ftp', 'get_ftp_daemon_info'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve extended information about the FTP server.

my $ftp_server = $cpliveapi->uapi(

'Ftp', 'get_ftp_daemon_info',

);

cPanel Template Toolkit

[% execute( 'Ftp', 'get_ftp_daemon_info' ); %]

Command Line

uapi --user=username Ftp get_ftp_daemon_info

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
    "messages": null,
    "errors": null,
    "status": 1,
    "metadata": {},
    "data": {
        "supports": {
            "quota": 1,
            "login_without_domain": 0
        },
        "name": "pure-ftpd",
        "enabled": 1
    }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
name	string	The FTP server's name.	pure-ftpd proftpd An empty string.	pure-ftpd
enabled	Boolean	Whether the server's FTP daemon is enabled.	1 — Enabled. 0 — Disable.	1
supports	hash	This hash contains the features that the FTP daemon supports.	This hash includes the quota andlogin_without_domain returns.
quota	Boolean	Whether the FTP daemon supports disk quotas. The function returns this value in thesupports hash.	1 — Supported. 0 — Not supported.	1
login_without_domain	Boolean	Whether the FTP daemon supports username authentication without the user's domain. The function returns this value in thesupports hash.	1 — Supported. 0 — Not supported.	0

Knowledgebase

Categories

Categories