Return current user's additional domains

This function returns a list of addon domains that belong to the current user.

Important: When you disable the Web Server role, the system disables this function.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  convert_addon_list_addon_domains

Response samples

Content type
application/json
{
  • "data": {
    • "example.com": {
      • "docroot": "/home/exampleparent/public_html/example.com",
      • "domain_type": "addon",
      • "ip": "192.0.2.0",
      • "owner": "root",
      • "subdomain": "example.exampleparent.com"
      }
    },
  • "metadata": {
    • "command": "convert_addon_list_addon_domains",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}