認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/subdomains \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The subdomains served by the site's hosting package and the document root each one points at. ⛔ Subdomains are the only surface here with a real **quantity** ceiling: `limit` is the lower of what the package template permits and what the customer bought, so `can_create` is arithmetic and not merely `permitted`. ⚖️ **On our own fleet the ceiling is the plan's `max_sites`, because a subdomain spends one of them** (owner ruling 2026-09-01). `limit` is then the site cap and `used` carries how much of it is already spent — by the customer's **sites as well as their subdomains** — so a client must render the caption from `used` and not from `data.length`. On the resold line `used` is absent and counting the rows is correct; nothing else about the shape differs. Requires `sites.view`. `404` for a site with no managed hosting package and no own-fleet placement.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | SiteSubdomain[] | はい | The subdomains on the package. |
limit | VendorAllowance | はい | The effective ceiling on subdomains for this site. |
permitted | boolean | はい | Whether the package type includes subdomains at all. |
can_create | boolean | はい | `permitted`, **and** the effective ceiling has room. |
used | integer | いいえ | How much of `limit` is already spent, when that is **not** `data.length`. ⚖️ Present only on our own fleet, where a subdomain consumes one of the plan's `max_sites` slots (owner… |
このエンドポイントが返すエラー
401 · 403 · 404 · 429 · 503