Description

This function retrieves the authname value from an .htaccess file.

Examples 



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$retrieve_authname = $cpanel->api1('Htaccess','resname', array('directoryname') ); // Call the function.



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $retrieve_authname = $cpliveapi->api1('Htaccess','resname', ['directoryname'] ); # Call the function.

 


<cpanel Module="Htaccess::resname($FORM('dir') )">




cpapi1 --user=username Htaccess resname directoryname



user




Parameters

ParameterTypeDescriptionPossible valuesExample

dir

string

Required

The directory name.

A valid directory name.directoryname

Returns

This function displays the desired authname value.


Function information



Module:


Htaccess




API Version:


cPanel API 1




Available in:


cPanel 11+




Methods:


GET, POST




Required Parameters:


dir




Return Formats:


plaintext



About this module

The Htaccess module manages functionality within the .htaccess file.

About cPanel API 1

Find a function

Related functions