domains
POST /v1/domains/{domainId}/index-check/run
Run a fresh search-index check for a domain.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/index-check/run \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
domainId (path) | Uuid | Sì | The domain's id. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
fqdn | string | Sì | — |
state | string<indexed, not_indexed, unknown, never_checked> | Sì | `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 | No | When the stored check ran. Null when never checked. |
is_stale | boolean | Sì | 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 | No | 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[] | No | 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 | No | When this domain is next due for an automatic check. Indexed sites are re-checked monthly, missing ones daily, and unknown ones within hours. |
Errori che questo endpoint può restituire
401 · 403 · 404 · 429 · 503