hosting
POST /v1/sites/{siteId}/subdomains
Add a subdomain to a site.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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コンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 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. |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429 · 503