UAPI Functions - Ftp::get_welcome_message - Knowledgebase

Description

This function retrieves the cPanel account's FTP welcome message.

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

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

// Get the account's FTP welcome message.

$ftp_welcome = $cpanel->uapi(

'Ftp', 'get_welcome_message'

);

LiveAPI Perl Module

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

# Get the account's FTP welcome message.

my $ftp_welcome = $cpliveapi->uapi(

'Ftp', 'get_welcome_message',

);

cPanel Template Toolkit

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

Command Line

uapi --user=username Ftp get_welcome_message

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": "Greetings, Professor Falken."
}

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
data	string	The cPanel account's FTP welcome message.	A string value.	Greetings, Professor Falken.

Knowledgebase

Categories

Categories