clientapi_cpanel.FtpApi

All URIs are relative to https://cpanel-server.tld:2083/execute

Method	HTTP request	Description
add_ftp	GET /Ftp/add_ftp	Create FTP account
allows_anonymous_ftp	GET /Ftp/allows_anonymous_ftp	Return if anonymous FTP connections allowed
allows_anonymous_ftp_incoming	GET /Ftp/allows_anonymous_ftp_incoming	Return if anonymous FTP transfers allowed
delete_ftp	GET /Ftp/delete_ftp	Delete FTP account
ftp_exists	GET /Ftp/ftp_exists	Return whether an FTP account exists
get_ftp_daemon_info	GET /Ftp/get_ftp_daemon_info	Return FTP server's information
get_port	GET /Ftp/get_port	Return FTP server's port
get_quota	GET /Ftp/get_quota	Return FTP account's quota
get_welcome_message	GET /Ftp/get_welcome_message	Return FTP account's welcome message
kill_session	GET /Ftp/kill_session	Stop FTP session
list_ftp	GET /Ftp/list_ftp	Return FTP accounts
list_ftp_with_disk	GET /Ftp/list_ftp_with_disk	Return FTP accounts and disk usage
list_sessions	GET /Ftp/list_sessions	Return FTP server's active sessions
passwd	GET /Ftp/passwd	Update FTP account's password
server_name	GET /Ftp/server_name	Return whether server uses ProFTPD or Pure-FTPd
set_anonymous_ftp	GET /Ftp/set_anonymous_ftp	Enable or disable anonymous FTP logins
set_anonymous_ftp_incoming	GET /Ftp/set_anonymous_ftp_incoming	Enable or disable anonymous incoming FTP transfers
set_homedir	GET /Ftp/set_homedir	Update FTP account's home directory
set_quota	GET /Ftp/set_quota	Update FTP account's quota
set_welcome_message	GET /Ftp/set_welcome_message	Update FTP welcome message

add_ftp

InlineResponse200243 add_ftp(user, disallowdot=disallowdot, domain=domain, homedir=homedir, var_pass=var_pass, pass_hash=pass_hash, quota=quota)

Create FTP account

This function creates an FTP account.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200243 import InlineResponse200243
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    user = 'username' # str | The new FTP account username.
    disallowdot = 1 # int | Whether to strip dots (`.`) from the username.  * `1` — Strip dots. * `0` — Do **not** strip dots. (optional) (default to 1)
    domain = 'example.com' # str | The FTP user's associated domain. This must be a domain that the cPanel account owns.  **Note:**  This parameter defaults to the cPanel account's primary domain. (optional)
    homedir = 'exampleftp' # str | The path to the FTP account's root directory, relative to the cPanel account's home directory. If you don't set this, it defaults to a directory with the same name as the FTP account. (optional)
    var_pass = '123456luggage' # str | The new FTP account password.  **Note:**  You can use the `pass_hash` parameter in place of this parameter. However, you **cannot** use both the `pass` and `pass_hash` parameters in the same request. (optional)
    pass_hash = '' # str | The account's password hash.  **Note:**  * You can use this parameter in place of the `pass` parameter. However, you **cannot** use both the `pass` and `pass_hash` parameters in the same request. * You can find your server's password hash type in the `/etc/sysconfig/authconfig` file. (optional) (default to '')
    quota = 0 # int | The FTP account's maximum disk usage quota, in megabytes (MB).  **Note:**  A value of `0` grants the FTP account unlimited disk space. (optional) (default to 0)

    try:
        # Create FTP account
        api_response = api_instance.add_ftp(user, disallowdot=disallowdot, domain=domain, homedir=homedir, var_pass=var_pass, pass_hash=pass_hash, quota=quota)
        print("The response of FtpApi->add_ftp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->add_ftp: %s\n" % e)

Parameters

Name	Type	Description	Notes
user	str	The new FTP account username.
disallowdot	int	Whether to strip dots (`.`) from the username. * `1` — Strip dots. * `0` — Do not strip dots.	[optional] [default to 1]
domain	str	The FTP user's associated domain. This must be a domain that the cPanel account owns. Note: This parameter defaults to the cPanel account's primary domain.	[optional]
homedir	str	The path to the FTP account's root directory, relative to the cPanel account's home directory. If you don't set this, it defaults to a directory with the same name as the FTP account.	[optional]
var_pass	str	The new FTP account password. Note: You can use the `pass_hash` parameter in place of this parameter. However, you cannot use both the `pass` and `pass_hash` parameters in the same request.	[optional]
pass_hash	str	The account's password hash. Note: * You can use this parameter in place of the `pass` parameter. However, you cannot use both the `pass` and `pass_hash` parameters in the same request. * You can find your server's password hash type in the `/etc/sysconfig/authconfig` file.	[optional] [default to '']
quota	int	The FTP account's maximum disk usage quota, in megabytes (MB). Note: A value of `0` grants the FTP account unlimited disk space.	[optional] [default to 0]

Return type

InlineResponse200243

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

allows_anonymous_ftp

InlineResponse200244 allows_anonymous_ftp()

Return if anonymous FTP connections allowed

This function checks whether the account allows anonymous FTP connections.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200244 import InlineResponse200244
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)

    try:
        # Return if anonymous FTP connections allowed
        api_response = api_instance.allows_anonymous_ftp()
        print("The response of FtpApi->allows_anonymous_ftp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->allows_anonymous_ftp: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200244

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

allows_anonymous_ftp_incoming

InlineResponse200245 allows_anonymous_ftp_incoming()

Return if anonymous FTP transfers allowed

This function checks whether the account allows inbound anonymous FTP transfers.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200245 import InlineResponse200245
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)

    try:
        # Return if anonymous FTP transfers allowed
        api_response = api_instance.allows_anonymous_ftp_incoming()
        print("The response of FtpApi->allows_anonymous_ftp_incoming:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->allows_anonymous_ftp_incoming: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200245

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_ftp

InlineResponse200246 delete_ftp(user, destroy=destroy, domain=domain)

Delete FTP account

This function deletes an FTP account.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200246 import InlineResponse200246
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    user = 'username' # str | The FTP account's username.
    destroy = 0 # int | Whether to delete the FTP account's home directory.  * `1` — Delete the home directory. * `0` — Do **not** delete the home directory. (optional) (default to 0)
    domain = 'example.com' # str | The user's associated domain.  **Note:**  This parameter defaults to the cPanel account's primary domain. (optional)

    try:
        # Delete FTP account
        api_response = api_instance.delete_ftp(user, destroy=destroy, domain=domain)
        print("The response of FtpApi->delete_ftp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->delete_ftp: %s\n" % e)

Parameters

Name	Type	Description	Notes
user	str	The FTP account's username.
destroy	int	Whether to delete the FTP account's home directory. * `1` — Delete the home directory. * `0` — Do not delete the home directory.	[optional] [default to 0]
domain	str	The user's associated domain. Note: This parameter defaults to the cPanel account's primary domain.	[optional]

Return type

InlineResponse200246

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ftp_exists

InlineResponse200247 ftp_exists(user, domain=domain)

Return whether an FTP account exists

This function checks whether an FTP account exists.

Note:

This function returns only metadata if the FTP account exists, or an error if the FTP account does not exist.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200247 import InlineResponse200247
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    user = 'us_chickens' # str | The FTP account's username.
    domain = 'example.com' # str | The user's associated domain.  **Note:**  This parameter defaults to the cPanel account's primary domain. (optional)

    try:
        # Return whether an FTP account exists
        api_response = api_instance.ftp_exists(user, domain=domain)
        print("The response of FtpApi->ftp_exists:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->ftp_exists: %s\n" % e)

Parameters

Name	Type	Description	Notes
user	str	The FTP account's username.
domain	str	The user's associated domain. Note: This parameter defaults to the cPanel account's primary domain.	[optional]

Return type

InlineResponse200247

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_ftp_daemon_info

InlineResponse200248 get_ftp_daemon_info()

Return FTP server's information

This function retrieves the extended information about the server's FTP daemon.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200248 import InlineResponse200248
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)

    try:
        # Return FTP server's information
        api_response = api_instance.get_ftp_daemon_info()
        print("The response of FtpApi->get_ftp_daemon_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->get_ftp_daemon_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200248

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_port

InlineResponse200249 get_port()

Return FTP server's port

This function returns the FTP port.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200249 import InlineResponse200249
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)

    try:
        # Return FTP server's port
        api_response = api_instance.get_port()
        print("The response of FtpApi->get_port:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->get_port: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200249

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_quota

InlineResponse200250 get_quota(account, domain=domain)

Return FTP account's quota

This function checks an FTP account's quota.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200250 import InlineResponse200250
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    account = 'user1' # str | The FTP account's username.
    domain = 'example.com' # str | The user's associated domain.  **Note:**  This parameter defaults to the cPanel account's primary domain. (optional)

    try:
        # Return FTP account's quota
        api_response = api_instance.get_quota(account, domain=domain)
        print("The response of FtpApi->get_quota:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->get_quota: %s\n" % e)

Parameters

Name	Type	Description	Notes
account	str	The FTP account's username.
domain	str	The user's associated domain. Note: This parameter defaults to the cPanel account's primary domain.	[optional]

Return type

InlineResponse200250

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_welcome_message

InlineResponse200251 get_welcome_message()

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.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200251 import InlineResponse200251
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)

    try:
        # Return FTP account's welcome message
        api_response = api_instance.get_welcome_message()
        print("The response of FtpApi->get_welcome_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->get_welcome_message: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200251

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

kill_session

InlineResponse200252 kill_session(login=login)

Stop FTP session

This function kills FTP sessions.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200252 import InlineResponse200252
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    login = 'all' # str | 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. (optional) (default to 'all')

    try:
        # Stop FTP session
        api_response = api_instance.kill_session(login=login)
        print("The response of FtpApi->kill_session:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->kill_session: %s\n" % e)

Parameters

Name	Type	Description	Notes
login	str	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.	[optional] [default to 'all']

Return type

InlineResponse200252

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_ftp

InlineResponse200253 list_ftp(include_acct_types=include_acct_types, skip_acct_types=skip_acct_types)

Return FTP accounts

This function lists FTP account information.

Important:

When you disable the FTP role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200253 import InlineResponse200253
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    include_acct_types = 'main|anonymous' # str | A list of the FTP account types to include in the function's results.  * `anonymous` * `logaccess` * `main` * `sub`  If you do not specify this parameter, this function returns all FTP account types.  **Note:**  * Separate multiple types with the pipe character (`|`). * In browser-based calls, use `%7C`. (optional)
    skip_acct_types = 'main|anonymous' # str | A list of the FTP account types to exclude from the function's results.  * `anonymous` * `logaccess` * `main` * `sub`  If you do not specify this parameter, this function does **not** exclude any account types.  **Note:**  * Separate multiple types with the pipe character (`|`). * In browser-based calls, use `%7C`. (optional)

    try:
        # Return FTP accounts
        api_response = api_instance.list_ftp(include_acct_types=include_acct_types, skip_acct_types=skip_acct_types)
        print("The response of FtpApi->list_ftp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->list_ftp: %s\n" % e)

Parameters

Name	Type	Description	Notes
include_acct_types	str	A list of the FTP account types to include in the function's results. * `anonymous` * `logaccess` * `main` * `sub` If you do not specify this parameter, this function returns all FTP account types. Note: * Separate multiple types with the pipe character (`	`). * In browser-based calls, use `%7C`.
skip_acct_types	str	A list of the FTP account types to exclude from the function's results. * `anonymous` * `logaccess` * `main` * `sub` If you do not specify this parameter, this function does not exclude any account types. Note: * Separate multiple types with the pipe character (`	`). * In browser-based calls, use `%7C`.

Return type

InlineResponse200253

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_ftp_with_disk

InlineResponse200254 list_ftp_with_disk(include_acct_types=include_acct_types, skip_acct_types=skip_acct_types)

Return FTP accounts and disk usage

This function lists FTP account and disk usage information.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200254 import InlineResponse200254
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    include_acct_types = 'main|anonymous' # str | A pipe-delimited list of the FTP account types to include in the function's results. If you do not specify this parameter, the function returns all FTP account types.  Valid types for this list are:  * `anonymous` * `logaccess` * `main` * `sub` (optional)
    skip_acct_types = 'main|anonymous' # str | A pipe-delimited list of the FTP account types to exclude from the function's results. If you do not specify this parameter, the function does **not** exclude any account types.  Valid types for this list are:  * `anonymous` * `logaccess` * `main` * `sub` (optional)

    try:
        # Return FTP accounts and disk usage
        api_response = api_instance.list_ftp_with_disk(include_acct_types=include_acct_types, skip_acct_types=skip_acct_types)
        print("The response of FtpApi->list_ftp_with_disk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->list_ftp_with_disk: %s\n" % e)

Parameters

Name	Type	Description	Notes
include_acct_types	str	A pipe-delimited list of the FTP account types to include in the function's results. If you do not specify this parameter, the function returns all FTP account types. Valid types for this list are: * `anonymous` * `logaccess` * `main` * `sub`	[optional]
skip_acct_types	str	A pipe-delimited list of the FTP account types to exclude from the function's results. If you do not specify this parameter, the function does not exclude any account types. Valid types for this list are: * `anonymous` * `logaccess` * `main` * `sub`	[optional]

Return type

InlineResponse200254

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_sessions

InlineResponse200255 list_sessions()

Return FTP server's active sessions

This function lists the FTP server's active sessions.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200255 import InlineResponse200255
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)

    try:
        # Return FTP server's active sessions
        api_response = api_instance.list_sessions()
        print("The response of FtpApi->list_sessions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->list_sessions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200255

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

passwd

InlineResponse200256 passwd(var_pass, user, domain=domain)

Update FTP account's password

This function changes an FTP account's password.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200256 import InlineResponse200256
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    var_pass = '12345luggage' # str | The FTP account's new password.
    user = 'ftpaccount' # str | The FTP account username.
    domain = 'example.com' # str | The user's associated domain.  **Note:**  This parameter defaults to the cPanel account's primary domain (optional)

    try:
        # Update FTP account's password
        api_response = api_instance.passwd(var_pass, user, domain=domain)
        print("The response of FtpApi->passwd:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->passwd: %s\n" % e)

Parameters

Name	Type	Description	Notes
var_pass	str	The FTP account's new password.
user	str	The FTP account username.
domain	str	The user's associated domain. Note: This parameter defaults to the cPanel account's primary domain	[optional]

Return type

InlineResponse200256

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

server_name

InlineResponse200257 server_name()

Return whether server uses ProFTPD or Pure-FTPd

This function checks whether the server uses ProFTPD or Pure-FTPd.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200257 import InlineResponse200257
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)

    try:
        # Return whether server uses ProFTPD or Pure-FTPd
        api_response = api_instance.server_name()
        print("The response of FtpApi->server_name:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->server_name: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200257

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_anonymous_ftp

InlineResponse200258 set_anonymous_ftp(set=set)

Enable or disable anonymous FTP logins

This function enables or disables anonymous FTP logins.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200258 import InlineResponse200258
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    set = 0 # int | Whether to enable or disable anonymous FTP logins.  * `1` - Enable. * `0` - Disable. (optional) (default to 0)

    try:
        # Enable or disable anonymous FTP logins
        api_response = api_instance.set_anonymous_ftp(set=set)
        print("The response of FtpApi->set_anonymous_ftp:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->set_anonymous_ftp: %s\n" % e)

Parameters

Name	Type	Description	Notes
set	int	Whether to enable or disable anonymous FTP logins. * `1` - Enable. * `0` - Disable.	[optional] [default to 0]

Return type

InlineResponse200258

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_anonymous_ftp_incoming

InlineResponse200259 set_anonymous_ftp_incoming(set=set)

Enable or disable anonymous incoming FTP transfers

This function enables or disables inbound anonymous FTP transfers.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200259 import InlineResponse200259
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    set = 0 # int | Whether to enable or disable inbound anonymous FTP transfers.  * `1` - Enable. * `0` - Disable. (optional) (default to 0)

    try:
        # Enable or disable anonymous incoming FTP transfers
        api_response = api_instance.set_anonymous_ftp_incoming(set=set)
        print("The response of FtpApi->set_anonymous_ftp_incoming:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->set_anonymous_ftp_incoming: %s\n" % e)

Parameters

Name	Type	Description	Notes
set	int	Whether to enable or disable inbound anonymous FTP transfers. * `1` - Enable. * `0` - Disable.	[optional] [default to 0]

Return type

InlineResponse200259

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_homedir

InlineResponse200260 set_homedir(user, domain=domain, homedir=homedir)

Update FTP account's home directory

This function changes the home directory for FTP accounts.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200260 import InlineResponse200260
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    user = 'example1' # str | The FTP account username.
    domain = 'example.com' # str | The user's associated domain.  **Note:**  The default value is the cPanel account's primary domain. (optional)
    homedir = 'user@domain/' # str | The FTP account's home directory  **Note:**  This parameter defaults to the `user@domain` subdirectory in the cPanel account's home directory with the name, where user and domain represent the `user` and `domain` parameters. (optional) (default to 'user@domain/')

    try:
        # Update FTP account's home directory
        api_response = api_instance.set_homedir(user, domain=domain, homedir=homedir)
        print("The response of FtpApi->set_homedir:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->set_homedir: %s\n" % e)

Parameters

Name	Type	Description	Notes
user	str	The FTP account username.
domain	str	The user's associated domain. Note: The default value is the cPanel account's primary domain.	[optional]
homedir	str	The FTP account's home directory Note: This parameter defaults to the `user@domain` subdirectory in the cPanel account's home directory with the name, where user and domain represent the `user` and `domain` parameters.	[optional] [default to 'user@domain/']

Return type

InlineResponse200260

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_quota

InlineResponse200261 set_quota(user, domain=domain, kill=kill, quota=quota)

Update FTP account's quota

This function changes an FTP account's quota.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200261 import InlineResponse200261
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    user = 'ftpaccount' # str | The FTP account username.
    domain = 'example.com' # str | The user's associated domain.  **Note:**  The default value is the cPanel account's primary domain. (optional)
    kill = 0 # int | Whether to disable quotas for the FTP account. * `1` - Disable quotas. * `0` - Enable quotas.  **Note:**   If you disable quotas for an FTP account, you grant that account unlimited disk space. (optional) (default to 0)
    quota = 0 # int | The new quota, in megabytes.  **Note:**  Setting this parameter to `0` grants the account unlimited disk space. (optional) (default to 0)

    try:
        # Update FTP account's quota
        api_response = api_instance.set_quota(user, domain=domain, kill=kill, quota=quota)
        print("The response of FtpApi->set_quota:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->set_quota: %s\n" % e)

Parameters

Name	Type	Description	Notes
user	str	The FTP account username.
domain	str	The user's associated domain. Note: The default value is the cPanel account's primary domain.	[optional]
kill	int	Whether to disable quotas for the FTP account. * `1` - Disable quotas. * `0` - Enable quotas. Note: If you disable quotas for an FTP account, you grant that account unlimited disk space.	[optional] [default to 0]
quota	int	The new quota, in megabytes. Note: Setting this parameter to `0` grants the account unlimited disk space.	[optional] [default to 0]

Return type

InlineResponse200261

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_welcome_message

InlineResponse200262 set_welcome_message(message)

Update FTP welcome message

This function sets the FTP welcome message.

Important:

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

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200262 import InlineResponse200262
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.FtpApi(api_client)
    message = 'Greetings, Professor Falken.' # str | The cPanel account's new FTP welcome message.

    try:
        # Update FTP welcome message
        api_response = api_instance.set_welcome_message(message)
        print("The response of FtpApi->set_welcome_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FtpApi->set_welcome_message: %s\n" % e)

Parameters

Name	Type	Description	Notes
message	str	The cPanel account's new FTP welcome message.

Return type

InlineResponse200262

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

FtpApi.md

Latest commit

History

FtpApi.md

File metadata and controls

clientapi_cpanel.FtpApi

add_ftp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

allows_anonymous_ftp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

allows_anonymous_ftp_incoming

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_ftp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ftp_exists

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_ftp_daemon_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_port

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_quota

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_welcome_message

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

kill_session

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_ftp

Example

Parameters