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

Description

This function sets the FTP welcome message.

Important:

In cPanel & WHM version 76 and later, when you disable the FTP role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_welcome_message?message=Greetings%2C%20Professor%20Falken.


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.
 
// Set the FTP welcome message.
$welcome = $cpanel->uapi(
    'Ftp', 'set_welcome_message',
    array(
        'message'    => 'Greetings, Professor Falken.',
         )
);


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.
 
# Set the FTP welcome message.
my $welcome = $cpliveapi->uapi(
    'Ftp', 'set_welcome_message',
    {
        'message'    => 'Greetings, Professor Falken.',
    }
);


Note:

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

 

 cPanel Template Toolkit
<!-- Set the FTP welcome message. -->
[% execute( 'Ftp', 'set_welcome_message', { message => 'Greetings, Professor Falken.' } ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Ftp set_welcome_message message='Greetings, Professor Falken.'


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,
   "metadata":{  

   },
   "data":null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
messagestring

Required

The cPanel account's new FTP welcome message.

A string.

Greetings, Professor Falken.

Returns

This function returns only metadata.