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