CPcpanel
DirectoryIndexes
Directory Indexes

Return directory indexing settings

This function returns the directory indexing settings for a directory on the cPanel account and its subdirectories.

get/DirectoryIndexes/get_indexing

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

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

The directory for which to check the indexing type.

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": "get_indexing",
  "module": "DirectoryIndexes",
  "result": {
    "data": "disabled",
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.