domains

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

Run a fresh search-index check for a domain.

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

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.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`domainId (path)`	`Uuid`	ہاں	The domain's id.

جواب

نام	قسم	لازمی	یہ کیا ہے
`fqdn`	`string`	ہاں	—
`state`	`string<indexed, not_indexed, unknown, never_checked>`	ہاں	`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`	نہیں	When the stored check ran. Null when never checked.
`is_stale`	`boolean`	ہاں	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`	نہیں	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[]`	نہیں	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`	نہیں	When this domain is next due for an automatic check. Indexed sites are re-checked monthly, missing ones daily, and unknown ones within hours.

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 404 · 429 · 503

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