CPcpanel
SubDomain

List the reserved subdomain names

This function lists the subdomain labels that the system reserves, and that an account therefore cannot use to create a subdomain.

Note:

The returned labels are not sorted.

get/SubDomain/getreservedsubdomains

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Response

HTTP Request was successful.

datastring[]

One entry for each reserved subdomain label.

errorsstring[] nullable
messagesstring[] nullable
status0 | 1
  • 1 — Success.
  • 0 — Failed. Check the errors field for more details.
warningsstring[] nullable

Example response

{
  "data": [
    "www"
  ],
  "status": 1
}

Changes

No recorded changes to this operation across all 5 revisions of this API.