hosting

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

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

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.crawler.manage; ключ без него отклоняется с кодом 403, а не 404.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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 в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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