hosting

POST `/v1/sites/{siteId}/databases`

Create an extra MySQL database on a site.

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 POST https://api.zinndigital.com/v1/sites/{siteId}/databases \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

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

Creates <site database>_<name> with its own user, and grants the site's own database user access to it as well, so the site's phpMyAdmin shows it. The password is generated by the platform and returned once, in this response only — it is stored nowhere on our side and cannot be read back. The ceiling is applied before the server is called: a site at its limit is refused 422 with a sentence that says how to buy another, and so is a name that is taken or not allowed. Requires sites.view and sites.panel_access.

Parameters

Name	Type	Required	What it is
`siteId (path)`	`Uuid`	Yes	Site ID (UUIDv7).

Request body

Name	Type	Required	What it is
`name`	`string`	Yes	The part after `<site database>_`: lowercase letters and numbers, up to 16 characters. It cannot be changed later.

Response

Name	Type	Required	What it is
`database`	`SiteMysqlDatabase`	Yes	—
`password`	`string`	Yes	Generated by the platform and returned once. It cannot be read back.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/databases