Park

Remove a parked (aliased) domain

This function unparks (removes the alias for) a domain on the cPanel account.

Important:

  • This function removes the alias only. It does not remove the subdomain that an addon domain is parked on. To remove both, use the AddonDomain::deladdondomain function instead.
  • The account must have either the Parked Domains or the Addon Domains feature.

When you disable the Web Server role, the system disables this function.

get/Park/unpark

Request

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

Query parameters

domainstring domain required
Example:alias.example.com

The parked domain to remove.

subdomainstring
Example:shop_example.com

The subdomain that the domain is parked on, given in the underscore-separated form that the AddonDomain::listaddondomains function returns in its domainkey field.

Omit this parameter to let the system determine the subdomain. Pass it only when the domain is parked on a subdomain rather than on the primary domain.

Response

HTTP Request was successful.

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

Example response

{
  "status": 1
}

Changes

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