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

Description

This function checks whether the account allows anonymous FTP connections.

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/allows_anonymous_ftp


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.
 
// Check whether anonymous FTP is enabled.
$anon_ftp_enabled = $cpanel->uapi(
    'Ftp', 'allows_anonymous_ftp'
);


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.
 
# Check whether anonymous FTP is enabled.
my $anon_ftp_enabled = $cpliveapi->uapi(
    'Ftp', 'allows_anonymous_ftp',
);


Note:

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

 

 cPanel Template Toolkit
<!-- Check whether anonymous FTP is enabled. -->
[% execute( 'Ftp', 'allows_anonymous_ftp' ); %]


Note:

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

 

 Command Line
uapi --user=username Ftp allows_anonymous_ftp 


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,
  "data": {
    "allows": 0
  }
}


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
allowsBooleanWhether the cPanel account allows anonymous FTP connections.
  • 1 — Allowed.
  • 0 — Not allowed.
1