CPcpanel
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

Request

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

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
  }
}

Changes

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