hosting
GET /v1/wordpress/sites
List every WordPress site the caller owns, across all product lines.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/wordpress/sites \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
The fleet manager's list: every wordpress or woocommerce site in the caller's tenancy subtree, on every product line and every deploy target (own fleet, managed shared, managed cloud, CloudLinux), with each one's stored WordPress posture. ⛔ This endpoint never calls a vendor, however stale a row is. Collecting is refreshWordPressSite, an explicit act; a row that has never been collected reports update_state: unknown with a null snapshot, and the client renders that as "not checked yet" — never as "up to date". Those are different sentences and a customer acts differently on each. update_state and needs_attention are applied after pagination, because the state is derived from four snapshot columns with an explicit precedence and re-expressing that precedence in SQL would give this list and getWordPressFleetOverview two implementations of one rule. A filtered page can therefore be short; the totals come from the overview, which counts everything. Requires sites.view.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
cursor (query) | string | Нет | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | Нет | Maximum items to return (page size). |
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… |
q (query) | string | Нет | Substring match on the primary domain. |
product_line (query) | string | Нет | — |
deploy_target (query) | string | Нет | — |
update_state (query) | WordPressUpdateState | Нет | 422 on an unrecognised value rather than silently returning everything — a filter that quietly does nothing is how a customer concludes their estate is clean. |
needs_attention (query) | boolean | Нет | Only sites with a core or component update waiting, no WordPress installed, or a homepage that is not answering. |
health (query) | string<, healthy, unhealthy> | Нет | Filter by the stored health verdict. ⭐ Applied in the database, unlike update_state — health_status is one indexed column written by one function, so there is no… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
data | WordPressFleetSite[] | Да | — |
page | PageMeta | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 422 · 429