hosting
POST /v1/sites/{siteId}/subdomains
Add a subdomain to a site.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.view; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/subdomains \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Adds one subdomain to the package. The effective ceiling is applied before the vendor is called: a package type that does not permit subdomains, and a customer who has used the last of their allowance, are both 422 with a sentence they can act on. ⛔ The response is the row the platform stored, not the name that was requested — the vendor normalises and namespaces it, so the client shows what came back. ⚖️ On our own fleet this spends one of the plan's site slots (owner ruling 2026-09-01), so the refusal at the cap is the same event as it is on site create and carries the same SITE_QUOTA_EXCEEDED code and figures. The row comes back pending: the DNS record, the virtual host and the chosen stack are built by a durable workflow, and the row reaches active when the name is serving. A build that cannot be done — a hostname whose DNS we do not control, or one this server's certificate cannot cover — lands in failed with the reason in status_detail. 404 for a site with no managed hosting package and no own-fleet placement. Requires sites.view and sites.panel_access.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
siteId (path) | Uuid | Да | Site ID (UUIDv7). |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
name | string | Да | The subdomain to add. What the vendor actually created comes back in SiteSubdomain.name, and that — never this — is what the client shows. |
stack_type | string<static, php, wordpress, woocommerce> | Не | What the subdomain should run. ⚖️ Owner ruling 2026-09-01 — a new subdomain "will start as whatever they select". static and php give an empty document root to upload or… |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
name | string | Да | The subdomain as the platform stored it. ⛔ Not necessarily what was requested — a vendor normalises it, and the client shows this value. |
document_root | string | Да | The folder it serves. Relative to the package root on a resold package; an absolute path on our own fleet, where it is read back from the server's own configuration rather than… |
stack_type | string | Не | What this subdomain runs, as the customer chose at creation. ⛔ Empty on a resold package, where the folder is the vendor's and there is no stack we chose — deliberately blank… |
status | string<pending, active, failed, deleting, > | Не | Where the build has got to. pending while the record, the virtual host and the stack are being put in place; active once the name serves; deleting after a delete, when the… |
status_detail | string | Не | Why it failed, or a note about a build that partly succeeded — a sentence written for the customer. Empty on a healthy row. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 409 · 422 · 429 · 503