hosting

GET /v1/sites/{siteId}

Get a site.

Bütün hosting nöqtələri

Doğrulama

API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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

Parametrlər

AdTipTələb olunurNədir
siteId (path)UuidBəliSite ID (UUIDv7).

Cavab

AdTipTələb olunurNədir
idUuidBəliUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidBəliUUIDv7 identifier — sortable by creation time (docs/02 §8).
product_linestringBəliProduct line code this site belongs to (CLAUDE.md §2.14).
sourceSiteSourceBəliWhere 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 **customer's…
blueprint_idUuid | nullXeyrThe exact blueprint version the site was built from; null for imports.
subscription_idUuid | nullXeyrThe subscription entitling this site; null while unassigned.
plan_codestring | nullXeyrStable 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 | nullXeyrDisplay 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 orde…
seoSiteSeoSummary | nullXeyr**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, comput…
primary_domainHostnameBəliA fully-qualified DNS hostname, lowercase, no trailing dot.
namestringXeyrHuman label for the site; defaults to the primary domain.
stack_typeStackTypeBəliThe application stack a site runs (docs/04 §1). `nextcloud`, `owncloud` and `headless_cms` are **own-fleet only** (docs/139): we install them ourselves from each project's own d…
runtimeRuntimeBəliThe runtime the web server serves the site with.
php_versionstringXeyrThe 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…
statusSiteStatusBəliA 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 t…
status_reasonSiteStatusReason | nullXeyrWhy 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_stepstringXeyrWHERE 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 sa…
failed_activitystringXeyrThe 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 saf…
regionstringXeyrWhere 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 placemen…
cdn_vendorstringXeyrThe 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_vendorstringXeyrThe DNS vendor this site's zone was pinned to, or `""` when the footprint balancer chooses.
deploy_targetstringXeyrWhere 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, neve…
deletion_statestring<none, scheduled, running, stalled, deleted>XeyrWhether 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. ⛔ **An a…
deletion_scheduled_forstringXeyrWhen 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 t…
created_atstringBəli
updated_atstringXeyr

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 429