Return built-in subdomain aliases

This function returns the built-in subdomain aliases for an account's main domain.

Note:

This function retrieves data from the /var/cpanel/userdata/user/domain file, where user represents the cPanel account username and domain represents the domain. For this reason, actual output may not contain all of the returns that this document lists.

SecurityBasicAuth

Request

query Parameters

hide_temporary_domains

integer

Default: 0

Whether to hide domain aliases if the main domain is a temporary domain.

1 — Return empty array if the main domain is a temporary domain.
0 — Show aliases regardless of domain type.

Enum: 1 0

Example: hide_temporary_domains=1

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/DomainInfo/main_domain_builtin_subdomain_aliases

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  DomainInfo \
  main_domain_builtin_subdomain_aliases

Response samples

application/json

{"apiversion": 3,
"func": "main_domain_builtin_subdomain_aliases",
"module": "DomainInfo",
"result": {"data": ["mail",
"www"
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}