Return all domains information

This function returns information about each domain on the server.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  get_domain_info

Response samples

Content type
application/json
{
  • "data": {
    • "domains": [
      • {
        • "docroot": "/home/user1/public_html/example.com",
        • "domain": "example.com",
        • "domain_type": "addon",
        • "ipv4": "192.0.2.255",
        • "ipv4_ssl": "192.0.2.255",
        • "ipv6": "2001:DB8:g1m:0N3y::1",
        • "ipv6_is_dedicated": 1,
        • "modsecurity_enabled": 1,
        • "parent_domain": "example.com",
        • "php_version": "ea-php54",
        • "port": 80,
        • "port_ssl": 443,
        • "user": "username",
        • "user_owner": "user1"
        }
      ]
    },
  • "metadata": {
    • "command": "get_domain_info",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}