DomainLookup

Return every domain's document root

This function retrieves the document root for every domain on the cPanel account, including the primary domain, addon domains, parked domains and subdomains.

get/DomainLookup/getdocroots

Request

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

Response

HTTP Request was successful.

errorsstring[] nullable
messagesstring[] nullable
status0 | 1
  • 1 — Success.
  • 0 — Failed. Check the errors field for more details.
warningsstring[] nullable

Example response

{
  "data": [
    {
      "docroot": "/home/username/public_html",
      "domain": "example.com"
    }
  ],
  "status": 1
}

Changes

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