hosting

POST `/v1/sites/{siteId}/mysql-access`

Allow one IP address to reach MySQL as one database user.

Authentication

Send an API key as a bearer token. The key must carry the sites.panel_access 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}/mysql-access \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "user_id": <integer>, "address": <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

Opens a database port to an address on the public internet, so this requires `sites.panel_access` — the same trust level as the file manager and the database credentials. Only a single IPv4 or IPv6 address is accepted: a hostname or a CIDR range is refused here rather than accepted by the vendor and silently matching nothing. The vendor takes up to 30 minutes to apply the rule.

Parameters

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

Request body

Name	Type	Required	What it is
`user_id`	`integer`	Yes	⛔ The vendor's numeric user id, not the username. A request keyed by username is accepted and stores nothing.
`address`	`string`	Yes	A single IPv4 or IPv6 address. Ranges and hostnames are refused.

Response

Name	Type	Required	What it is
`data`	`SiteMysqlAccessUser[]`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/mysql-access