add_ftpuser()

Create an FTP user.

All API functions FTP

Signature

add_ftpuser(array $parameters): mixed

Parameters

Pass these parameters as KasRequestParams. Every request also requires kas_login, kas_auth_type, and kas_auth_data, as shown in SOAP with PHP.

Name Description Requirement
ftp_password The FTP password Required
ftp_comment The comment Required
ftp_path The path of the login Optional Default: /
ftp_permission_read The user may read: Y|N Optional Default: Y
ftp_permission_write The user may write: Y|N Optional Default: Y
ftp_permission_list The user may list directories: Y|N Optional Default: Y
ftp_virus_clamav Virus protection for the user: Y|N Optional Default: Y

PHP example

<?php

// $sessionToken is returned by KasAuth, see SOAP with PHP.
$parameters = [
    'ftp_password' => 'my_ftp_password',
    'ftp_path' => 'ftp-path',
    'ftp_comment' => 'ftp_comment',
    'ftp_permission_read' => 'Y',
    'ftp_permission_write' => 'N',
    'ftp_permission_list' => 'N',
];

try {
    $client = new SoapClient('https://kasapi.kasserver.com/soap/wsdl/KasApi.wsdl');
    $response = $client->KasApi(json_encode([
        'kas_login' => 'w0123456',
        'kas_auth_type' => 'session',
        'kas_auth_data' => $sessionToken,
        'kas_action' => 'add_ftpuser',
        'KasRequestParams' => $parameters,
    ]));
    print_r($response);
} catch (SoapFault $fault) {
    echo 'Error: ' . $fault->faultstring;
}
Open interactive example

Responses and error codes

  • TRUE the action was carried out
  • missing_parameter a required parameter is missing
  • couldnt_get_kas_ressources
  • ftp_comment_syntax_incorrect
  • ftp_permission_list_syntax_incorrect
  • ftp_permission_read_syntax_incorrect
  • ftp_permission_write_syntax_incorrect
  • ftp_virus_clamav_syntax_incorrect
  • max_ftpuser_reached
  • password_syntax_incorrect
  • path_syntax_incorrect