Child pages
  • cPanel API 1 Functions - Fileman::listtemplates
Skip to end of metadata
Go to start of metadata

Description

This function lists file templates from the /usr/local/cpanel/share/templates directory.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Important:

In cPanel & WHM version 76 and later, when you disable the FileStorage role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$list_templates = $cpanel->api1('Fileman', 'listtemplates'); // Call the function.


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.
my $list_templates = $cpliveapi->api1('Fileman', 'listtemplates'); # Call the function.


Note:

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

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Fileman::listtemplates ()">
 Command Line
cpapi1 --user=username Filename listtemplates


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (HTML)
<html>
<option value="Text Document">Text Document</option>
<option value="HTML Document">HTML Document</option>
<option value="Perl Script">Perl Script</option>
<option value="Shell Script">Shell Script</option>
<option value="Text Document">Text Document</option>
</html>

Parameters

This function does not accept parameters.

Returns

This function returns all available file templates in HTML format.