hosting
GET /v1/sites/{siteId}/wordpress
Get the WordPress install on a site.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.view; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/wordpress \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
installed | boolean | Sim | Whether WordPress is on the package at all. |
version | string | Sim | The installed version, or `""` when the vendor did not state one. |
is_latest | boolean | Sim | ⛔ **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 fo… |
is_multisite | boolean | Sim | Whether the install is a WordPress network. |
update_available | boolean | Sim | 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 | Sim | The version waiting, or `""` when the install is current. |
site_url | string | Sim | The URL WordPress believes it is served from. |
wizard_required | boolean | Sim | 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> | Sim | ⛔ **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… |
capabilities | object | Sim | 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 usabl… |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429 · 503