Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran sites.view; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/subdomains \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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`.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
siteId (path) | Uuid | Ya | Site ID (UUIDv7). |
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
name | string | Ya | 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> | Tidak | 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 d… |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
name | string | Ya | 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 | Ya | 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 | Tidak | 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 blan… |
status | string<pending, active, failed, deleting, > | Tidak | 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 | Tidak | Why it failed, or a note about a build that partly succeeded — a sentence written for the customer. Empty on a healthy row. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 409 · 422 · 429 · 503