v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Park

List the parked (aliased) domains

This function lists the domains that are parked (aliased) on the cPanel account's primary domain.

Note:

This function lists only the domains parked on the primary domain. Use the AddonDomain::listaddondomains function for the domains parked on a subdomain.

get/Park/listparkeddomains

Query parameters

regexstring
Example:example[.]com$

A Perl regular expression. The system returns only the parked domains whose name matches this pattern, case-insensitively.

return_https_redirect_status0 | 1
Example:1

Whether to include the can_https_redirect and is_https_redirecting fields in each entry.

  • 1 - Include the HTTPS redirect status.
  • 0 - Omit the HTTPS redirect status.

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": [
    {
      "basedir": "public_html",
      "can_https_redirect": 1,
      "dir": "/home/username/public_html",
      "domain": "alias.example.com",
      "reldir": "home:public_html"
    }
  ],
  "status": 1
}