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

Description

This function sets the index behavior 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.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer 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.
$set_index = $cpanel->api1('Htaccess','setindex', array('directoryname','0') ); // 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_index = $cpliveapi->api1('Htaccess','setindex', ['directoryname','0'] ); # 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::setindex( $FORM('dir','ival') )">
 Command Line
cpapi1 --user=username Htaccess setindex directoryname 0


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 (plaintext)
The output contains a synopsis of the index changes.

Parameters

ParameterTypeDescriptionPossible valuesExample

dir

string

Required

The directory name

A value directory name.directoryname
ivalinteger

Required

The directory behavior(s) to set for the index.

  • 2 — Options All, Indexes, IndexOptions, FancyIndexing
  • 1 — Options All, Indexes, IndexOptions, -FancyIndexing
  • 0 — Options All, Indexes
  • -1 — Options All
0

Returns

This function displays a summary of the index changes.