hosting
GET /v1/sites/{siteId}/database
Get a site's database size and panel links.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/database \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
The per-site Tools tab's Database card — the site's MySQL size and table count, plus single-use SSO links into the phpMyAdmin and File Manager panels. Requires **both** `sites.view` and `sites.panel_access` — the panels are full database and filesystem access, which is strictly more than listing a site — and is RLS-scoped to a site the caller holds `sites.panel_access` over, so holding the key in one org never reaches another org's site. An out-of-scope or unknown id is a `404`, exactly like `getSite`; a caller who can see the site but lacks `sites.panel_access` gets a `403`. **The data source is provisioned, not synchronous.** The size/table figures come from the site's fleet worker and the panels are stood up per host behind Cloudflare Access. Until a host is serving them, `available` is `false` and every figure and panel URL is `null` — never a fabricated `0` or a link to a panel that is not there. The shape is stable, so populating it later is not a contract change. Panel URLs, when present, are always HTTPS single-use links minted on read (a non-HTTPS panel URL is never returned).
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
siteId (path) | Uuid | بله | Site ID (UUIDv7). |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
available | boolean | بله | Whether a host is serving this site's database + panels yet. |
reason | string | خیر | Why a link or a figure is missing, in words a customer can act on. `available: false` alone cannot distinguish "this site has no server yet" from "we could not reach the box" fr… |
reason_code | string | خیر | A stable, machine-readable name for the reason above — the half a CLIENT should render. `reason` is English prose for staff, SDK consumers and support tickets; this platform shi… |
size_mb | object | بله | Total database size in MB; null when unavailable. |
tables | object | بله | Number of tables in the database; null when unavailable. |
phpmyadmin_sso_url | object | بله | HTTPS single-use SSO link into phpMyAdmin, minted on read; null when the panel is not provisioned. Never a non-HTTPS URL. |
filemanager_sso_url | object | بله | HTTPS single-use SSO link into the File Manager, minted on read; null when the panel is not provisioned. Never a non-HTTPS URL. |
web_ide_sso_url | object | بله | HTTPS single-use SSO link into the Web IDE — real VS Code (`code-server`) running in the browser against this site's files. Minted on read; null when the site is not on one of o… |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 429