hosting
GET /v1/sites/{siteId}/databases
List a site's databases.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/databases \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
data | SiteHostingDatabase[] | Oui | The databases on the package. |
limit | VendorAllowance | Oui | The effective ceiling on databases for this site. |
permitted | boolean | Oui | Whether the package type includes databases at all. |
can_create | boolean | Oui | `permitted`, **and** the effective ceiling has room. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429 · 503