Return privacy status of subdirectories

This function returns the privacy status of the subdirectories in a directory.

SecurityBasicAuth

Request

query Parameters

dir

required

string <path>

The directory path for which to return the subdirectories' privacy information.

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/DirectoryPrivacy/list_directories

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  DirectoryPrivacy \
  list_directories \
  dir='/home/example/example.com'

Response samples

application/json

{"apiversion": 3,
"func": "list_directories",
"module": "DirectoryPrivacy",
"result": {"data": {"children": [{"path": "/home/example/example.com/cgi-bin",
"state": {"auth_name": "Protected 'example.com'",
"auth_type": "Basic",
"passwd_file": "/home/example/.htpasswds/example.com/passwd",
"protected": 1
}
}
],
"current": {"path": "/home/example/example.com",
"state": {"auth_name": "protected",
"auth_type": "Basic",
"passwd_file": "/home/example/.htpasswds/example.com/passwd",
"protected": 1
}
},
"home": {"path": "/home/example",
"state": {"auth_name": "protected",
"auth_type": "Basic",
"passwd_file": "/home/example/.htpasswds/example.com/passwd",
"protected": 1
}
},
"parent": {"path": "/home/example",
"state": {"auth_name": "protected",
"auth_type": "Basic",
"passwd_file": "/home/example/.htpasswds/example.com/passwd",
"protected": 1
}
}
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}