hosting
POST /v1/wordpress/sites/{siteId}/refresh
Ask this site's platform for its WordPress posture now.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/wordpress/sites/{siteId}/refresh \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
siteId (path) | Uuid | Да | Site ID (UUIDv7). |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
site_id | string | Да | — |
name | string | Да | — |
primary_domain | string | Да | — |
stack_type | string | Да | `wordpress` or `woocommerce` — a shop IS a WordPress site. |
product_line | string | Да | — |
deploy_target | string | Да | — |
status | string | Да | — |
php_version | string | Да | — |
plan_name | string | Да | The plan a customer would recognise, or `""`. Never an id. |
site_url | string | Да | — |
admin_url | string | Да | — |
update_state | WordPressUpdateState | Да | ⛔⛔ **`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 | Да | 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 | Да | — |
http_error_code | WordPressProbeErrorCode | Да | 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 | Да | — |
can_install | boolean | Да | 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 | Да | What this site's platform permits, as of the last collection. |
disk | WordPressAllowance | Да | 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 | Да | 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 | Да | ⛔ **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[] | Да | — |
themes | WordPressComponent[] | Да | — |
admins | WordPressAdmin[] | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422 · 429 · 503