We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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


This function returns HTML to display an interface to modify the dohtaccess.html file.


cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

  • UAPI (recommended) — Mime::list_directories — 

    Error rendering macro 'excerpt-include'

    No link could be created for 'SWAT:UAPI Functions - DirectoryPrivacy::list_directories'.

  • cPanel API 2 — None.


In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$set_index = $cpanel->api1('Htaccess','htdirls', array('directoryname','1') ); // Call the function.


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 $set_index = $cpliveapi->api1('Htaccess','htdirls', ['directoryname','1'] ); # Call the function.


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

 cPanel Tag System (deprecated)


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="Htaccess::htdirls( $FORM('dir','listtype') )">
 Command Line
cpapi1 --user=username Htaccess htdirls directoryname 1


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


 Output (HTML)
<b><a href="/frontend/paper_lantern/test.html?dir=%2fhome%2fusername%2fpublic_html%2ftest"><img
 src="images/i-directory.gif" border="0"></a> <a href="/frontend/paper_lantern/test.html">/</a></b>
 <a href="/frontend/paper_lantern/test.html?dir=%2fhome%2fusername%2Fpublic_html%2f">public_html</a> / 
 <a href="dohtaccess.html?dir=%2fhome%2fusername%2Fpublic_html%2ftest%2f">test</a> / 
 <i>(Current Folder)</i>
 <br />
 <a href="/frontend/paper_lantern/test.html?dir=%2fhome%2fusername%2fpublic_html%2f"><img
 src="images/i-directory.gif" border="0"></a> <a href="/frontend/paper_lantern/test.html?dir=%2fhome%2fusername%2fpublic_html%2f"><b>Up One Level</b></a>


ParameterTypeDescriptionPossible valuesExample




The directory to include in the listing.

A value directory name.directoryname


The list type to use.

  • 1 — Print HTML that links to images/noindex.gif
  • 2 — Print HTML that links to images/leech.gif (for leech protection).


This function returns HTML with a summary of the changes.