---
title: "Create an addon domain"
method: GET
path: "/AddonDomain/addaddondomain"
tags: ["AddonDomain"]
---

# Create an addon domain

`GET /AddonDomain/addaddondomain`

This function creates an addon domain on the cPanel account. It creates a
subdomain of the account's primary domain and then parks the new domain on
that subdomain.

**Important:**

- The account's primary domain may **not** be a subdomain of the addon
  domain that you create.
- You cannot create a wildcard addon domain.
- If the subdomain already exists on the account, the system reuses it
  rather than failing.
- If the park step fails, the system removes the subdomain it created, so
  that a failed call does not leave a partial addon domain behind.
- The system also creates an [FTP](https://go.cpanel.net/ftpaccounts)
  account for the addon domain, which counts against the account's FTP
  account limit.

When you disable the [Web Server role](https://go.cpanel.net/serverroles#roles),
the system **disables** this function.

## Query parameters

- `newdomain` string, domain, required
- `subdomain` string, required
- `dir` string, path
- `disallowdot` 0 | 1
- `force` 0 | 1

## Response `200`

HTTP Request was successful.

- object
  - `data` object — The created addon domain.
    - `domain` string, domain — The addon domain that the system created.
  - `errors` string[], nullable
  - `messages` string[], nullable
  - `metadata` object
    - `transformed` integer
  - `status` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `errors` field for more details.
  - `warnings` string[], nullable

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)