reseller
GET /v1/reseller/services/{siteId}
One provisioned service.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation reseller.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
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/reseller/services/{siteId} \
-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 same row `listResellerServices` returns, for one site. A site outside your client subtree is a 404, never a 403 — so this is not an existence oracle. Requires `reseller.view`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
org_id (query) | Uuid | Non | Which of your organizations this applies to. Required only when you belong to more than one here. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
site_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_name | string | Oui | — |
primary_domain | string | Oui | — |
name | string | Non | — |
status | SiteStatus | Oui | A site's lifecycle state (docs/04 §3). A newly created site is `pending` until the provisioning workflow picks it up; `deleted` is terminal. `restricted` and `quarantined` are t… |
product_line | object | Non | — |
plan_code | object | Non | — |
plan_name | object | Non | — |
held_by_reseller | boolean | Non | True when the current suspension was placed through this surface, which is the only case `unsuspendResellerService` will release. A site suspended by the abuse desk reports fals… |
pending_deletion_at | object | Non | When a scheduled deletion falls due, or null. |
sell_amount_minor | object | Non | What YOU charge for this plan, in minor units of `sell_currency` — your own price-list row if you have authored one, otherwise our list price with your default markup applied. N… |
sell_currency | object | Non | — |
created_at | string | Oui | — |
disk_used_bytes | object | Non | Null when the hosting platform has no usage to report for this site. |
bandwidth_used_bytes | object | Non | Outbound bandwidth this billing period, or null. |
usage_measured_at | object | Non | When the reading was taken. Null alongside null usage — so "we have not measured this" is never mistaken for "it used nothing" (§2.44). |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429