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.

Authorizations:

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username Ftp get_welcome_message

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_welcome_message",
  • "module": "Ftp",
  • "result": {
    • "data": "Greetings, Professor Falken.",
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}