We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - Ftp::get_welcome_message
Skip to end of metadata
Go to start of metadata

Description

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

Important:

In cPanel & WHM version 76 and later, when you disable the FTP role, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_welcome_message


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 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'
);


Note:

For more information, read our Guide to the LiveAPI System.


 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',
);


Note:

For more information, read our Guide to the LiveAPI System.


 Command Line
uapi --user=username Ftp get_welcome_message


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": "Greetings, Professor Falken."
}


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
datastringThe cPanel account's FTP welcome message.

A string value.

Greetings, Professor Falken.