hosting

GET `/v1/wordpress/sites`

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

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X GET https://api.zinndigital.com/v1/wordpress/sites \
  -H "Authorization: Bearer zdk_live_…"

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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`.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`cursor (query)`	`string`	Non	Opaque cursor from a previous page's `page.next_cursor`.
`limit (query)`	`integer`	Non	Maximum items to return (page size).
`org_id (query)`	`string`	Non	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`	Non	Substring match on the primary domain.
`product_line (query)`	`string`	Non	—
`deploy_target (query)`	`string`	Non	—
`update_state (query)`	`WordPressUpdateState`	Non	`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`	Non	Only sites with a core or component update waiting, no WordPress installed, or a homepage that is not answering.
`health (query)`	`string<, healthy, unhealthy>`	Non	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 precede…

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`data`	`WordPressFleetSite[]`	Oui	—
`page`	`PageMeta`	Oui	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 422 · 429