hosting
GET /v1/wordpress/overview
Count the caller's whole WordPress estate by posture.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/wordpress/overview \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
The manager's tiles, counted over **every** site in scope rather than over the current page. ⛔ A tile derived from one page would read *"3 sites need attention"* and mean *"3 on this page"*, which is the reading a customer will not make. `never_collected` is reported separately from `unknown` on purpose: the first is *"nobody has ever asked this site"*, the second also covers *"we asked and the platform declined to say"*. Requires `sites.view`.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
org_id (query) | string | Нет | Narrow to one organisation in the caller's subtree. Equivalent to the `X-Zinn-Org` header, which is now read centrally for every org-scoped operation — this parameter wins where… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
total | integer | Да | — |
installed | integer | Да | — |
core_updates | integer | Да | — |
component_updates | integer | Да | — |
current | integer | Да | — |
unknown | integer | Да | — |
not_installed | integer | Да | — |
unreachable | integer | Да | Sites whose homepage answered 4xx/5xx, or did not answer at all. |
never_collected | integer | Да | Sites nobody has ever asked. Reported separately from `unknown`, which also covers *"we asked and the platform declined to say"*. |
healthy | integer | Да | Sites assessed, with no critical finding. |
unhealthy | integer | Да | Sites assessed, with at least one critical finding. |
health_unknown | integer | Да | ⛔⛔ **Sites we have not assessed, and the counter that makes the other two honest.** `healthy + unhealthy + health_unknown == total`, always. Without it an estate nobody had ever… |
by_deploy_target | object | Да | — |
by_product_line | object | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 429