hosting
GET /v1/sites/{siteId}/wordpress
Get the WordPress install on a site.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/wordpress \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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 for… |
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 a… |
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 usable… |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 429 · 503