UAPI Functions - Ftp::set_anonymous_ftp

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

 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',
         )
);

 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',
    }
);

 cPanel Template Toolkit

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

 Command Line

uapi --user=username Ftp set_anonymous_ftp set=0

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":null
}

 

Note:

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

 

Parameters

 Parameter 

Type

Description

Possible values

 Example 

set

 Boolean 

Required

 Whether to enable or disable anonymous FTP logins. 

  • 1 — Enable.
  • 0 — Disable. 

0

Returns

This function returns only metadata.

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....