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.
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/compute/servers \
-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
Every machine the caller can see, or — with ?org_id= — one organisation's. The scoped form is what a reseller's console sends. An organisation outside the readable scope narrows to nothing rather than 403-ing, exactly as listSites does: a 403 would confirm the organisation exists. ⛔ Resolved from our own rows, not from the provider's listing, which is every customer on the reseller account. status is ours (how far the order got) and power_state is the machine's (what it is doing now); they are separate facts and rounding the provider's word into ours would silently make an unrecognised state active, which is what unlocks the power and resize controls. operable is read rather than re-derived from status, so a screen never offers a control the engine refuses. Requires sites.view.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
org_id (query) | Uuid | Non | Narrow the list to one organisation the caller can read. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
data | ComputeServer[] | Oui | The machines, across every organisation the caller can read. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429 · 503