v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
WebVhosts
Virtual Host Information

Return virtual host names for domains

This function lists virtual host names for each domain.

get/WebVhosts/list_domains

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_domains",
  "module": "WebVhosts",
  "result": {
    "data": [
      {
        "domain": "example.com",
        "proxy_subdomains": [
          "cpanel",
          "webmail",
          "autodiscover",
          "whm",
          "webdisk"
        ],
        "vhost_is_ssl": 1,
        "vhost_name": "hostname.example.com"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}