domains

POST /v1/domains/{domainId}/index-check/run

Run a fresh search-index check for a domain.

Wszystkie punkty końcowe domains

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/index-check/run \
  -H "Authorization: Bearer zdk_live_…"

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
domainId (path)UuidTakThe domain's id.

Odpowiedź

NazwaTypWymaganeCo to jest
fqdnstringTak
statestring<indexed, not_indexed, unknown, never_checked>Tak`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_atstringNieWhen the stored check ran. Null when never checked.
is_stalebooleanTakTrue 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_pagesintegerNieThe 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_urlsstring[]NieA 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_atstringNieWhen this domain is next due for an automatic check. Indexed sites are re-checked monthly, missing ones daily, and unknown ones within hours.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429 · 503