v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Ftp
FTP Accounts

Update FTP welcome message

This function sets the FTP welcome message.

Important:

When you disable the FTP role, the system disables this function.

get/Ftp/set_welcome_message

Query parameters

messagestring required
Example:Greetings, Professor Falken.

The cPanel account's new FTP welcome message.

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": "set_welcome_message",
  "module": "Ftp",
  "result": {
    "status": 1
  }
}