v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Ftp
FTP Server Settings

Stop FTP session

This function kills FTP sessions.

Important:

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

get/Ftp/kill_session

Query parameters

loginstring
Example:weeones

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.

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