身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId} \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Returns a single site the principal can view. RLS-scoped.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
siteId (path) | Uuid | 是 | Site ID (UUIDv7). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
product_line | string | 是 | Product line code this site belongs to (CLAUDE.md §2.14). |
source | SiteSource | 是 | Where a site's initial content came from (docs/04 §2). blueprint is a fresh site off one of our published stack recipes. site_blueprint is a copy of one of the… |
blueprint_id | Uuid | null | 否 | The exact blueprint version the site was built from; null for imports. |
subscription_id | Uuid | null | 否 | The subscription entitling this site; null while unassigned. |
plan_code | string | null | 否 | Stable code of the plan behind this site's subscription (e.g. pbn_25); null when the site has no subscription. Use this, not plan_name, for filters, saved views and support… |
plan_name | string | null | 否 | Display name of the plan behind this site's subscription; null when the site has no subscription (a real state — a trial, an internal site, or a site provisioned before its order… |
seo | SiteSeoSummary | null | 否 | This site's search-index status and authority metrics, on the list row. The same readings GET /v1/sites/{siteId}/index-check and /seo-metrics return for one site, computed… |
primary_domain | Hostname | 是 | A fully-qualified DNS hostname, lowercase, no trailing dot. |
name | string | 否 | Human label for the site; defaults to the primary domain. |
stack_type | StackType | 是 | The application stack a site runs (docs/04 §1). nextcloud, owncloud, headless_cms and php_app are own-fleet only (docs/139, docs/564): we install them ourselves from… |
runtime | Runtime | 是 | The runtime the web server serves the site with. |
php_version | string | 否 | The PHP version this site is pinned to, or "" when it follows the product line's current default. Echoed so a caller can confirm the choice it just made on create — without it,… |
status | SiteStatus | 是 | A site's lifecycle state (docs/04 §3). A newly created site is pending until the provisioning workflow picks it up; deleted is terminal. restricted and quarantined are the… |
status_reason | SiteStatusReason | null | 否 | Why the site is in that status. Null on any healthy site, and cleared the moment the site leaves failed — a reason that outlives its failure reads to the customer as current. |
failed_step | string | 否 | WHERE provisioning failed — the saga step that was running when it did, as a SiteFailedStep code the client localises, or "" when the site is not failed (cleared in the same… |
failed_activity | string | 否 | The activity that refused, by the name the worker registered it under (create_dns_zone, verify_site_serving). An identifier of ours, never the vendor's message, so it is safe… |
region | string | 否 | Where the site is running. On our own fleet this is the region of the box the site is placed on, not the region asked for at create time — the two can disagree when placement… |
cdn_vendor | string | 否 | The CDN vendor this site was pinned to, or "" when the footprint balancer chooses (the default, and the only value on a managed line). This is the customer's own choice echoed… |
dns_vendor | string | 否 | The DNS vendor this site's zone was pinned to, or "" when the footprint balancer chooses. |
deploy_target | string | 否 | Where the site actually runs (docs/62 §1) — fleet, cf_pages, twentyi_shared, and so on. Empty when it has not been decided. A machine identifier the client localises, never… |
panel_connection_id | Uuid | null | 否 | Which control panel this site's subscription lives on — the PanelConnection from GET /v1/panels/connections. Set only when deploy_target is plesk;… |
deletion_state | string<none, scheduled, running, stalled, deleted> | 否 | Whether this site is on its way out. The same five values as SiteDeletion.state, reused verbatim so a list chip and the danger zone cannot disagree inside one screen. ⛔… |
deletion_scheduled_for | string | 否 | When the teardown fires. Null unless a deletion is armed or running. Stored when the request is made rather than recomputed from the grace period, so a countdown already shown to… |
created_at | string | 是 | — |
updated_at | string | 否 | — |
此端点可能返回的错误
401 · 403 · 404 · 429