Child pages
  • UAPI Functions - Bandwidth::get_enabled_protocols
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Description

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

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Bandwidth/get_enabled_protocols


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


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


Note:

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

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


Note:

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

 Command Line
uapi --user=username Bandwidth get_enabled_protocols


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)
{  
   "result":{  
      "messages":null,
      "warnings":null,
      "status":1,
      "data":[  
         "imap",
         "pop3",
         "smtp"
      ],
      "metadata":{  
         "transformed":1
      },
      "errors":null
   }


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
dataarray of strings

The bandwidth protocols that the server records.

  • ftp
  • http

    Note:

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

  • imap
  • pop3
  • smtp
imap
  • No labels