Return directory indexing settings

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

SecurityBasicAuth

Request

query Parameters

dir

required

string

The directory for which to check the indexing type.

Example: dir=/home/example/example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/DirectoryIndexes/get_indexing

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  DirectoryIndexes \
  get_indexing \
  dir='/home/example/example.com'

Response samples

application/json

{"apiversion": 3,
"func": "get_indexing",
"module": "DirectoryIndexes",
"result": {"data": "disabled",
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}