認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/databases \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The MySQL databases on the site's hosting package, with the user bound to each so a connection string can be assembled. **No password is returned**: a database password exists in exactly one response on this platform, the one that created it, and there is no endpoint that reads one back. `limit` is the effective ceiling — the lower of what the package permits and what the customer bought. `permitted` and `can_create` answer the two different questions a screen must distinguish before it offers an "add" button. This is the customer's own control surface. It is deliberately **not** a link to any vendor database tool: no customer is ever sent to a vendor control panel (docs/62 §3.7). `404` for a site with no vendor hosting package. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | SiteHostingDatabase[] | はい | The databases on the package. |
limit | VendorAllowance | はい | The effective ceiling on databases for this site. |
permitted | boolean | はい | Whether the package type includes databases at all. |
can_create | boolean | はい | `permitted`, **and** the effective ceiling has room. |
このエンドポイントが返すエラー
401 · 403 · 404 · 429 · 503