hosting
POST /v1/wordpress/sites/{siteId}/refresh
Ask this site's platform for its WordPress posture now.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
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 POST https://api.zinndigital.com/v1/wordpress/sites/{siteId}/refresh \
-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
Collects core version, plugins, themes, administrators, enforced disk quota and a **cache-busted request to the site's own homepage**, then stores and returns them. ⛔ **Every read is independent.** A platform that answers the install call and refuses the user list produces a snapshot with a core version and no administrators — not an empty row. And a failed collection **keeps the previous figures**, recording `snapshot.collect_error_code` beside them: *"what we knew four hours ago, and why we could not refresh it"* is a better answer than a blanked screen, provided the screen says which it is showing. ⛔ `sites.panel_access`, not merely `sites.view`: this commissions real vendor work against a customer's site, and a read permission should not be able to spend somebody else's rate limit.
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 |
|---|---|---|---|
site_id | string | Oui | — |
name | string | Oui | — |
primary_domain | string | Oui | — |
stack_type | string | Oui | `wordpress` or `woocommerce` — a shop IS a WordPress site. |
product_line | string | Oui | — |
deploy_target | string | Oui | — |
status | string | Oui | — |
php_version | string | Oui | — |
plan_name | string | Oui | The plan a customer would recognise, or `""`. Never an id. |
site_url | string | Oui | — |
admin_url | string | Oui | — |
update_state | WordPressUpdateState | Oui | ⛔⛔ **`unknown` is a real member and must never be rendered as `current`.** *"We have not looked"* and *"you are up to date"* are different statements, and a manager that collaps… |
reachability | WordPressReachability | Oui | What a **visitor** gets from the site's own homepage, from a cache-busted request. ⛔⛔ This is the only field on this surface measured over the path a human actually uses. Every… |
http_status | integer | Oui | — |
http_error_code | WordPressProbeErrorCode | Oui | Why the homepage request did not complete, blank when it did (whatever the status). A code rather than a sentence, because a sentence composed in the engine is English for ever… |
http_checked_at | string | Oui | — |
can_install | boolean | Oui | Whether software can be installed on this site's platform at all. ⛔ `false` for every managed hosting site — this platform exposes no shell and no install endpoint across its AP… |
capabilities | object | Oui | What this site's platform permits, as of the last collection. |
disk | WordPressAllowance | Oui | One countable resource. ⛔ **Three states, not two.** `limit: null, unlimited: false` is *no ceiling is stated*; `unlimited: true` is *the plan sells this as unlimited*, which is… |
bandwidth | WordPressAllowance | Oui | One countable resource. ⛔ **Three states, not two.** `limit: null, unlimited: false` is *no ceiling is stated*; `unlimited: true` is *the plan sells this as unlimited*, which is… |
snapshot | WordPressSnapshot | Oui | ⛔ **Null means nobody has ever collected this site.** A client renders that as *"not checked yet"* with a refresh action — never as zeroes, which read as "you are up to date". |
plugins | WordPressComponent[] | Oui | — |
themes | WordPressComponent[] | Oui | — |
admins | WordPressAdmin[] | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429 · 503