認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/wordpress \
-H "Authorization: Bearer zdk_live_…"ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
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`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
installed | boolean | はい | Whether WordPress is on the package at all. |
version | string | はい | The installed version, or `""` when the vendor did not state one. |
is_latest | boolean | はい | ⛔ **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 | はい | Whether the install is a WordPress network. |
update_available | boolean | はい | 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 | はい | The version waiting, or `""` when the install is current. |
site_url | string | はい | The URL WordPress believes it is served from. |
wizard_required | boolean | はい | 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> | はい | ⛔ **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 | はい | 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… |
このエンドポイントが返すエラー
401 · 403 · 404 · 429 · 503