Child pages
  • UAPI Functions - Ftp::set_anonymous_ftp_incoming
Skip to end of metadata
Go to start of metadata

Description

This function enables or disables inbound anonymous FTP transfers.

Important:

In cPanel & WHM version 76 and later, when you disable the FTP role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_anonymous_ftp_incoming?set=0


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Disable inbound anonymous FTP transfers.
$anon_ftp = $cpanel->uapi(
    'Ftp', 'set_anonymous_ftp_incoming',
    array(
        'set'    => '0',
         )
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Disable inbound anonymous FTP transfers.
my $anon_ftp = $cpliveapi->uapi(
    'Ftp', 'set_anonymous_ftp_incoming',
    {
        'set'    => '0',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- Disable inbound anonymous FTP transfers. -->
[% execute( 'Ftp', 'set_anonymous_ftp_incoming', { set => '0' } ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Ftp set_anonymous_ftp_incoming set=0


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
setBoolean

Required

Whether to enable or disable inbound anonymous FTP transfers.

  • 1 — Enable.
  • 0 — Disable.
0

Returns

This function returns only metadata.