Stop FTP session

This function kills FTP sessions.

Important:

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

SecurityBasicAuth

Request

query Parameters

string

Default: "all"

The username for the session's FTP account.

Note:

To stop all FTP sessions for the cPanel account, set this parameter to the all value.

Example: login=weeones

Responses

200

HTTP Request was successful.

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

get/Ftp/kill_session

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Ftp \
  kill_session

Response samples

application/json

{"apiversion": 3,
"func": "kill_session",
"module": "Ftp",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}