hosting

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

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

Authentication

Send an API key as a bearer token. The key must carry the sites.crawler.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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[]> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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`.

Parameters

Name	Type	Required	What it is
`siteId (path)`	`Uuid`	Yes	Site ID (UUIDv7).

Request body

Name	Type	Required	What it is
`blocked`	`string[]`	Yes	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`	No	—
`ip_deny`	`boolean`	No	—

Response

Name	Type	Required	What it is
`site_id`	`Uuid`	Yes	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`policy`	`CrawlerPolicy`	Yes	—
`available_crawlers`	`CrawlerCatalogEntry[]`	Yes	—
`rendered`	`CrawlerPolicyRendered`	Yes	The rendered rule artifacts for the worker / Zinn® plugin to write.
`enforcement`	`CrawlerEnforcement`	No	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…

Errors this endpoint can return

401 · 403 · 404 · 422 · 429

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