cPanel API 2 Functions - UserHttpUtils::getdirindices

Description

This function retrieves a prioritized list of index files. The first file in the list that Apache finds will serve as a directory index.

 

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

 

Examples 


 WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=HttpUtils&cpanel_jsonapi_func=getdirindices

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Generate a list of Apache index files
$list_index $cpanel->api2(
    'UserHttpUtils''getdirindices'
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Generate a list of Apache index files
my $list_index $cpliveapi->api2(
    'UserHttpUtils''getdirindices'
);

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.


 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getdirindices",
    "data": [
      {
        "index": "index.html.var"
      },
      {
        "index": "index.htm"
      },
      {
        "index": "index.html"
      },
      {
        "index": "index.shtml"
      },
      {
        "index": "index.xhtml"
      },
      {
        "index": "index.wml"
      },
      {
        "index": "index.perl"
      },
      {
        "index": "index.pl"
      },
      {
        "index": "index.plx"
      },
      {
        "index": "index.ppl"
      },
      {
        "index": "index.cgi"
      },
      {
        "index": "index.jsp"
      },
      {
        "index": "index.js"
      },
      {
        "index": "index.jp"
      },
      {
        "index": "index.php4"
      },
      {
        "index": "index.php3"
      },
      {
        "index": "index.php"
      },
      {
        "index": "index.phtml"
      },
      {
        "index": "default.htm"
      },
      {
        "index": "default.html"
      },
      {
        "index": "home.htm"
      },
      {
        "index": "index.php5"
      },
      {
        "index": "Default.html"
      },
      {
        "index": "Default.htm"
      },
      {
        "index": "home.html"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "UserHttpUtils"
  }
}

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

This function does not accept parameters. 

Returns

 Parameter 

 Type 

Description

Possible values

Example

index

hash

 An index file in the Apache list. 

 A valid filename. 

 index.html 

 

  • 12 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....