v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
DirectoryPrivacy
Directory Privacy

Return authorized users for protected directory

This function returns the users who can access a password-protected directory on the cPanel account.

get/DirectoryPrivacy/list_users

Query parameters

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

The password-protected directory for which to return authorized users.

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_users",
  "module": "DirectoryPrivacy",
  "result": {
    "data": [
      "example1",
      "example2"
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}