Return additional domain data

This function retrieves domain data for an addon domain.

Important:

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

SecurityBasicAuth

Request

query Parameters

domain

required

string <domain>

The addon domain for which to retrieve details.

Example: domain=example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/convert_addon_fetch_domain_details

Request samples

whmapi1 --output=jsonpretty \
  convert_addon_fetch_domain_details \
  domain='example.com'

Response samples

application/json

{"data": {"docroot": "/home/exampleparent/public_html/example.com",
"has_dedicated_ip": 0,
"has_ssl_cert_installed": 0,
"ip": "192.0.2.0",
"is_sni_supported": 0,
"number_of_autoresponders": 0,
"number_of_domain_forwarders": 1,
"number_of_email_accounts": 2,
"number_of_email_forwarders": 1,
"owner": "username"
},
"metadata": {"command": "convert_addon_fetch_domain_details",
"reason": "OK",
"result": 1,
"version": 1
}
}