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

Description

This function enables password protection for a 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.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$set_protection = $cpanel->api1('Htaccess','set_protect', array('directoryname','1','protectme') ); // 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 $set_protection = $cpliveapi->api1('Htaccess','set_protect', ['directoryname','1','protectme'] ); # 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="Htaccess::set_protect($FORM('dir','pval',resname') )">
 Command Line
cpapi1 --user=username Htaccess set_protect directoryname 1 protectme


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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (none)
This function does not return output.

   

Parameters

ParameterTypeDescriptionPossible valuesExample

dir

text

Required

The directory name.

A valid directory name.directoryname
pvalBoolean

Required

Whether to enable password protection.

  • 1 — Enable.
  • 0 — Disable.
1
resnamestring

Required

The string to store as the authname value.

A valid string that matches the directory protection instance.
protectme

Returns

This function does not return output.