Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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

Paraméterek

NévTípusKötelezőMi ez
siteId (path)UuidIgenSite ID (UUIDv7).

Válasz

NévTípusKötelezőMi ez
idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
product_linestringIgenProduct line code this site belongs to (CLAUDE.md §2.14).
sourceSiteSourceIgenWhere 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 | nullNemThe exact blueprint version the site was built from; null for imports.
subscription_idUuid | nullNemThe subscription entitling this site; null while unassigned.
plan_codestring | nullNemStable 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 | nullNemDisplay 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 | nullNemThis 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_domainHostnameIgenA fully-qualified DNS hostname, lowercase, no trailing dot.
namestringNemHuman label for the site; defaults to the primary domain.
stack_typeStackTypeIgenThe 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…
runtimeRuntimeIgenThe runtime the web server serves the site with.
php_versionstringNemThe 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,…
statusSiteStatusIgenA 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 | nullNemWhy 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_stepstringNemWHERE 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_activitystringNemThe 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…
regionstringNemWhere 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_vendorstringNemThe 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_vendorstringNemThe DNS vendor this site's zone was pinned to, or "" when the footprint balancer chooses.
deploy_targetstringNemWhere 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 | nullNemWhich 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>NemWhether 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_forstringNemWhen 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_atstringIgen
updated_atstringNem

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429