hosting

GET /v1/wordpress/overview

Count the caller's whole WordPress estate by posture.

Alle hosting Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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

Parameter

NameTypErforderlichWas es ist
org_id (query)stringNeinNarrow 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…

Antwort

NameTypErforderlichWas es ist
totalintegerJa
installedintegerJa
core_updatesintegerJa
component_updatesintegerJa
currentintegerJa
unknownintegerJa
not_installedintegerJa
unreachableintegerJaSites whose homepage answered 4xx/5xx, or did not answer at all.
never_collectedintegerJaSites nobody has ever asked. Reported separately from `unknown`, which also covers *"we asked and the platform declined to say"*.
healthyintegerJaSites assessed, with no critical finding.
unhealthyintegerJaSites assessed, with at least one critical finding.
health_unknownintegerJa⛔⛔ **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_targetobjectJa
by_product_lineobjectJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 429