v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Ftp

FTP Accounts

Return FTP account's welcome message

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

Important:

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

get/Ftp/get_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": "get_welcome_message",
  "module": "Ftp",
  "result": {
    "data": "Greetings, Professor Falken.",
    "status": 1
  }
}