تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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