---
title: "Create subdomain"
method: GET
path: "/create_subdomain"
tags: ["DNS", "Domain Management"]
---

# Create subdomain

`GET /create_subdomain`

This function creates a subdomain.

## Query parameters

- `document_root` string, required
- `domain` string, domain, required
- `use_canonical_name` 0 | 1

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `username` string, username — The cPanel account username. **Note:** This return **only** appears if the function succeeds.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

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