v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
DirectoryIndexes
Directory Indexes

Update directory indexing settings

This function configures the directory indexing settings for a directory on the cPanel account.

get/DirectoryIndexes/set_indexing

Query parameters

dirstring path required
Example:/home/example/example.com

The directory for which to manage directory indexing.

type'standard' | 'disabled' | 'inherit' | 'fancy' required
Example:inherit

The type of directory indexing.

  • standard — The directory uses directory indexing with standard formatting.
  • disabled — The directory doesn't use directory indexing.
  • inherit — The directory uses the system's default settings.
  • fancy — The directory uses directory indexing with Apache FancyIndexing directive. The directory will include additional information such as file size and the date of the file's last update.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "set_indexing",
  "module": "DirectoryIndexes",
  "result": {
    "data": "disabled",
    "status": 1
  }
}