hosting
GET /v1/sites/{siteId}/database
Get a site's database size and panel links.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/database \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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