hosting
GET /v1/sites/{siteId}/hosting/usage
Get a site's current-period hosting usage.
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}/hosting/usage \
-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
Disk and outbound bandwidth for the site's package this period, read from the vendor — the same figures the metering basis uses (docs/62 §3.4). Inbound bytes are deliberately not reported: billing a customer for what was sent to their site would charge them for other people's traffic, including an attack. periods carries the daily/monthly/yearly series where the vendor publishes it, and is empty otherwise rather than fabricated. 404 for a site with no vendor 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 |
|---|---|---|---|
disk_used_mb | integer | Oui | Disk used this period, in MB. |
bandwidth_mb | integer | Oui | Outbound bandwidth this period, in MB. Inbound is never billed or shown. |
requests | integer | Oui | Hits this period, as the vendor counts them. |
periods | object | Oui | Daily / monthly / yearly hit and byte totals where the vendor publishes them; empty otherwise, never fabricated. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429 · 503