Return the cPanel account's primary domain

This function returns the cPanel account's main domain.

SecurityBasicAuth

Request

query Parameters

hide_temporary_domains

integer

Default: 0

Whether to hide temporary domains from the response.

1 — Return null if the main domain is a temporary domain.
0 — Return the main domain if it's a temporary domain.

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/primary_domain

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

{"apiversion": 3,
"func": "primary_domain",
"module": "DomainInfo",
"result": {"data": {"primary_domain": "example.com"
},
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}