# Return built-in subdomain aliases

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



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

Endpoint: GET /DomainInfo/main_domain_builtin_subdomain_aliases
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `hide_temporary_domains` (integer)
    Whether to hide domain aliases if the main domain is a temporary domain.

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

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "main_domain_builtin_subdomain_aliases"

  - `module` (string)
    The name of the module called.
    Example: "DomainInfo"

  - `result` (object)

  - `result.data` (array)
    A list of the built-in subdomain aliases for the account's main domain.
    Example: ["mail","www"]

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    *  - Success.
*  - Failed. Check the  field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.