hosting

PUT `/v1/sites/{siteId}/crawler-policy`

Set a site's SEO-crawler-blocking policy.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.crawler.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/crawler-policy \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "blocked": <string[]> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

Set which SEO crawlers to block (`blocked` is a list of crawler keys from the catalog). An unknown key is a `422`; a search engine has no key, so it can never be blocked. Publishes `site.crawler_policy_changed` so the server-level rules are re-written. Requires `sites.crawler.manage`.

参数

名称	类型	必填	内容简介
`siteId (path)`	`Uuid`	是	Site ID (UUIDv7).

请求正文

名称	类型	必填	内容简介
`blocked`	`string[]`	是	Crawler keys to block (from the catalog's `available_crawlers`). An unknown key is a 422; a search engine has no key and can never be blocked.
`robots_txt`	`boolean`	否	—
`ip_deny`	`boolean`	否	—

响应

名称	类型	必填	内容简介
`site_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`policy`	`CrawlerPolicy`	是	—
`available_crawlers`	`CrawlerCatalogEntry[]`	是	—
`rendered`	`CrawlerPolicyRendered`	是	The rendered rule artifacts for the worker / Zinn® plugin to write.
`enforcement`	`CrawlerEnforcement`	否	Whether the stored crawler policy is actually a rule on a web server, and if not why not (#1954, D8300). ⛔ These are two different questions and collapsing them is the defect th…

此端点可能返回的错误

401 · 403 · 404 · 422 · 429

PUT /v1/sites/{siteId}/crawler-policy