domains
POST /v1/domains/{domainId}/index-check/run
Run a fresh search-index check for a domain.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/index-check/run \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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