hosting

GET `/v1/wordpress/sites`

List every WordPress site the caller owns, across all product lines.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (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

التفاصيل

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

GET /v1/wordpress/sites