身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
此端点不需要组织 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