hosting
GET /v1/sites/{siteId}/subdomains
List a site's subdomains.
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}/subdomains \
-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 subdomains served by the site's hosting package and the document root each one points at. ⛔ Subdomains are the only surface here with a real quantity ceiling: limit is the lower of what the package template permits and what the customer bought, so can_create is arithmetic and not merely permitted. ⚖️ On our own fleet the ceiling is the plan's max_sites, because a subdomain spends one of them (owner ruling 2026-09-01). limit is then the site cap and used carries how much of it is already spent — by the customer's sites as well as their subdomains — so a client must render the caption from used and not from data.length. On the resold line used is absent and counting the rows is correct; nothing else about the shape differs. Requires sites.view. 404 for a site with no managed hosting package and no own-fleet placement.
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 | SiteSubdomain[] | Oui | The subdomains on the package. |
limit | VendorAllowance | Oui | The effective ceiling on subdomains for this site. |
permitted | boolean | Oui | Whether the package type includes subdomains at all. |
can_create | boolean | Oui | permitted, and the effective ceiling has room. |
used | integer | Non | How much of limit is already spent, when that is not data.length. ⚖️ Present only on our own fleet, where a subdomain consumes one of the plan's max_sites slots (owner… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429 · 503