hosting
GET /v1/sites/{siteId}/wordpress
Get the WordPress install on a site.
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}/wordpress \
-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
What WordPress is on the package, what version, whether an update is waiting, and — in one read — which of the eleven WordPress operations the package type permits. One read gates eleven buttons, so a customer never learns their plan's shape by pressing one and reading a refusal. is_latest is tri-state: null means the vendor did not say, which is not "out of date". update_available is the flag a screen should act on, because it is derived from the vendor's update object being non-empty rather than from a comparison between two version strings nobody parsed — ⛔ {} is how this platform says "no update", and it is falsy, so the presence of the key is not the signal. Reading what is installed is not gated on a capability: a screen has to be able to render "your plan does not include plugin management" beside the list of what is installed. 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 |
|---|---|---|---|
installed | boolean | Oui | Whether WordPress is on the package at all. |
version | string | Oui | The installed version, or "" when the vendor did not state one. |
is_latest | boolean | Oui | ⛔ Tri-state. Null means the vendor did not say, which is not "out of date": rendering an unknown as out of date invites a customer to run a core update on a live site for… |
is_multisite | boolean | Oui | Whether the install is a WordPress network. |
update_available | boolean | Oui | The flag a screen should act on. Derived from the vendor's update object being non-empty rather than from a comparison between two version strings nobody parsed — ⛔ {} is how… |
update_version | string | Oui | The version waiting, or "" when the install is current. |
site_url | string | Oui | The URL WordPress believes it is served from. |
wizard_required | boolean | Oui | Whether the install has never been through WordPress's own setup wizard — a half-installed site, not a broken one. |
unavailable_reason | string<, database, config, unreadable, not-routed> | Oui | ⛔ Read this before rendering installed. Empty means installed is authoritative. Non-empty means it is not: the probe failed and we could not determine the answer, so a… |
capabilities | object | Oui | Which of the eleven WordPress operations this package type permits, keyed by our stable machine identifiers — never a vendor string and never display text, so they are usable… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429 · 503