Description

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


Examples




https://hostname.example.com:2083/cpsess##########/execute/Bandwidth/get_enabled_protocols



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
//Retrieves the server's enabled protocols.
$get_protocols = $cpanel->uapi(
    'Bandwidth', 'get_enabled_protocols'
);



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



<!-- Retrieves the server's enabled protocols. -->
[% execute('Bandwidth', 'get_enabled_protocols') %]



uapi --user=username Bandwidth get_enabled_protocols



{  
   "result":{  
      "messages":null,
      "warnings":null,
      "status":1,
      "data":[  
         "imap",
         "pop3",
         "smtp"
      ],
      "metadata":{  
         "transformed":1
      },
      "errors":null
   }



Parameters

This function does not accept parameters.

Returns

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
imap