UAPI Functions - Ftp::allows_anonymous_ftp_incoming

Description

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

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Ftp/allows_anonymous_ftp_incoming

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Check whether inbound anonymous FTP is enabled.
$anon_ftp_enabled $cpanel->uapi(
    'Ftp''allows_anonymous_ftp_incoming'
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Check whether inbound anonymous FTP is enabled.
my $anon_ftp_enabled $cpliveapi->uapi(
    'Ftp''allows_anonymous_ftp_incoming',
);

 cPanel Template Toolkit

<!-- Check whether inbound anonymous FTP is enabled. -->
[% execute( 'Ftp', 'allows_anonymous_ftp_incoming' ); %]

 Command Line

uapi --user=username Ftp allows_anonymous_ftp_incoming

 

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "allows": 0
  }
}

 

Note:

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

   

Parameters

This function does not accept parameters.

Returns

 Return 

Type

Description

Possible values

 Example 

allows

 Boolean 

 Whether the cPanel account allows inbound anonymous FTP transfers. 

  • 1 — Allowed.
  • 0 — Not allowed. 

1

 

  • 10 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....