hosting
GET /v1/sites/{siteId}/databases
List a site's MySQL databases and the room to add more.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/databases \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The site's own database first, then every extra database it holds, each with its measured size (null when the server did not report one — never a made-up 0). Only sites on our own servers have this surface; any other site is 404. The ceiling is included + paid (docs/1081 §1). included is the plan's database allowance — a plan that publishes no figure still includes the site's own database, so it is never 0 — and paid counts the site's extra_database add-ons that are paid up today. can_create says whether one more fits under limit; can_buy says whether this caller may buy one more database for this site now, and extra_price is that price in the caller's currency (null when not on sale). A cancelled add-on never drops a database: the customer is refused a NEW one until they are back under the ceiling. Requires sites.view and sites.panel_access.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | SiteMysqlDatabase[] | Yes | The site's own database first, then its extras by name. |
limit | VendorAllowance | Yes | The effective ceiling on one site service, after the vendor package's allowance and the quantity the customer actually bought have been reconciled: the lower of the two, with… |
included | VendorAllowance | Yes | The effective ceiling on one site service, after the vendor package's allowance and the quantity the customer actually bought have been reconciled: the lower of the two, with… |
paid | integer | Yes | Extra-database add-ons for this site that are paid up today. |
permitted | boolean | Yes | — |
can_create | boolean | Yes | — |
can_buy | boolean | Yes | — |
extra_price | MoneyAmount | Yes | The monthly price of one more database, in the caller's currency. |
paid_slots | SiteMysqlDatabaseSlot[] | Yes | The extra-database slots bought for this site that are paid up today, oldest first, so the customer can stop one renewing (stopSiteDatabaseSlot). |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503