# cPanel API 2 Functions - UserHttpUtils::getdirindices

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

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

Warning::
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:
When you disable the [*Web Server* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Generate a list of Apache index files
$list_index = $cpanel->api2(
    'UserHttpUtils', 'getdirindices'
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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'
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warning:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
  - cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  - For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username UserHttpUtils getdirindices
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
index
td
em
hash
td
An index file in the Apache list.
td
A valid filename.
td
code
index.html
tr
td
code
                 reason               
td
em
string
td
p
span
A reason for failure.
p
This function only returns a 
code
reason
 value if there was an error.
p
span
br
p
br
td
span
A string that describes the error.
td
code
This is an error message.
tr
td
code
                 result               
td
em
Boolean
td
span
Whether the function succeeded.
td
ul
li
code
1
span
 — The function succeeded.
li
code
0
 — The function failed.
td
code
                 1