hosting
GET /v1/sites/{siteId}
Get a site.
Баталгаажуулалт
API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.
Энэ төгсгөл цэг нь ямар ч байгууллагын 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