Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId} \
  -H "Authorization: Bearer zdk_live_…"

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

Returns a single site the principal can view. RLS-scoped.

Параметри

НазваТипОбов'язковеЩо це таке
siteId (path)UuidТакSite ID (UUIDv7).

Відповідь

НазваТипОбов'язковеЩо це таке
idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
product_linestringТакProduct line code this site belongs to (CLAUDE.md §2.14).
sourceSiteSourceТак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_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_domainHostnameТакA fully-qualified DNS hostname, lowercase, no trailing dot.
namestringНіHuman label for the site; defaults to the primary domain.
stack_typeStackTypeТак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…
runtimeRuntimeТакThe 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,…
statusSiteStatusТак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_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