CPcpanel
DirectoryIndexes
Directory Indexes

Return subdirectories directory indexing settings

This function returns the directory indexing settings of the subdirectories in a directory.

get/DirectoryIndexes/list_directories

Request

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

Query parameters

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

The absolute path of the directory for which to return indexing information.

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": "list_directories",
  "module": "DirectoryIndexes",
  "result": {
    "data": {
      "children": [
        {
          "path": "/home/example/example.com/cgi-bin",
          "state": {
            "index_type": "inherit"
          }
        }
      ],
      "current": {
        "path": "/home/example/example.com",
        "state": {
          "index_type": "inherit"
        }
      },
      "home": {
        "path": "/home/example",
        "state": {
          "index_type": "inherit"
        }
      },
      "parent": {
        "path": "/home/example",
        "state": {
          "index_type": "inherit"
        }
      }
    },
    "status": 1
  }
}

Changes

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