hosting

GET /v1/sites/{siteId}

Get a site.

모든 hosting 엔드포인트

모든 개발자 문서

인증

Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.

이 엔드포인트는 조직 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)UuidSite ID (UUIDv7).

응답

이름유형필수설명
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
product_linestringProduct line code this site belongs to (CLAUDE.md §2.14).
sourceSiteSourceWhere 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_idUuid | null아니요The exact blueprint version the site was built from; null for imports.
subscription_idUuid | null아니요The subscription entitling this site; null while unassigned.
plan_codestring | 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_namestring | 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…
seoSiteSeoSummary | 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_domainHostnameA fully-qualified DNS hostname, lowercase, no trailing dot.
namestring아니요Human label for the site; defaults to the primary domain.
stack_typeStackTypeThe 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…
runtimeRuntimeThe runtime the web server serves the site with.
php_versionstring아니요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,…
statusSiteStatusA 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_reasonSiteStatusReason | 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_stepstring아니요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_activitystring아니요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…
regionstring아니요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_vendorstring아니요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_vendorstring아니요The DNS vendor this site's zone was pinned to, or "" when the footprint balancer chooses.
deploy_targetstring아니요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_idUuid | 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_statestring<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_forstring아니요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_atstring
updated_atstring아니요

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404 · 429