hosting

GET /v1/sites/{siteId}/wordpress/database-check

Check a site's WordPress database connection.

All hosting endpoints

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}/wordpress/database-check \
  -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

Whether the install can reach its own database. One boolean, because that is the whole answer the vendor gives and inventing detail around it would be fiction: a `false` here is the difference between *"my site is slow"* and *"my site is down"*. `404` for a site with no vendor hosting package. Requires `sites.view`.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).

Response

NameTypeRequiredWhat it is
okbooleanYesWhether the install can reach its database.

Errors this endpoint can return

401 · 403 · 404 · 429 · 503