Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function enables or disables anonymous FTP logins.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_anonymous_ftp?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 anonymous FTP logins.
$anon_ftp = $cpanel->uapi(
    'Ftp', 'set_anonymous_ftp',
    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 anonymous FTP logins.
my $anon_ftp = $cpliveapi->uapi(
    'Ftp', 'set_anonymous_ftp',
    {
        'set'    => '0',
    }
);

Note:

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

 

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

Note:

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

 

 Command Line
uapi --user=username Ftp set_anonymous_ftp 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. 
  • We introduced this functionality in cPanel & WHM version 56.

 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 anonymous FTP logins.

  • 1 — Enable.
  • 0 — Disable.
0

 

Returns

This function returns only metadata.