domains
POST /v1/domains/{domainId}/index-check/run
Run a fresh search-index check for a domain.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
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 POST https://api.zinndigital.com/v1/domains/{domainId}/index-check/run \
-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
Calls the upstream provider and stores a new check, then returns it in the same shape as the GET. **Consumes provider allowance on every call**, so it is driven by an explicit user action or the scheduled sweep — never by rendering a page. Returns 503 when the provider is unreachable, unconfigured, or the allowance is exhausted. In every one of those cases the previously stored reading is left untouched and still served by the GET — a failed check never writes a negative result.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
domainId (path) | Uuid | Ja | The domain's id. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
fqdn | string | Ja | — |
state | string<indexed, not_indexed, unknown, never_checked> | Ja | `indexed` — the provider answered and the search engine has this site. `not_indexed` — the provider answered and the search engine has nothing. A real measurement, and the one s… |
checked_at | string | Nein | When the stored check ran. Null when never checked. |
is_stale | boolean | Ja | True when the reading is older than the 7-day monitoring window, or absent entirely. A hint that a fresh check is worth its allowance — not an indication the result is wrong. |
estimated_indexed_pages | integer | Nein | The search engine's own loose upper bound for how many pages of this site it holds. **An estimate, not an authoritative count** — it routinely differs from Search Console by sev… |
sample_urls | string[] | Nein | A few URLs the search engine returned, so a customer can confirm the right site was matched. Evidence, not a sitemap — capped at five. |
next_check_at | string | Nein | When this domain is next due for an automatic check. Indexed sites are re-checked monthly, missing ones daily, and unknown ones within hours. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 429 · 503