Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - Bandwidth::get_enabled_protocols - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - Bandwidth::get_enabled_protocols
Skip to end of metadata
Go to start of metadata


This function returns a list of the server's enabled protocols.


 cPanel or Webmail Session URL


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.
//Retrieves the server's enabled protocols.
$get_protocols = $cpanel->uapi(
    'Bandwidth', 'get_enabled_protocols'


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.
# Retrieves the server's enabled protocols.
my $get_protocols = $cpliveapi->uapi(
    'Bandwidth', 'get_enabled_protocols'


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

 Command Line
uapi --user=username Bandwidth get_enabled_protocols


  • 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:


 Output (JSON)


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


This function does not accept parameters.


ReturnTypeDescriptionPossible valuesExample
dataarray of strings

The bandwidth protocols that the server records.

  • ftp
  • http


    This value includes all web traffic for the 80 and 443 ports.

  • imap
  • pop3
  • smtp
  • No labels