hosting

POST `/v1/sites/{siteId}/sitemap`

Start a sitemap crawl.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл sites.panel_access; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

⛔ 202, and the returned state describes a job that has STARTED. A crawler walks the whole site and may take minutes; the sitemap does not exist when this returns. Poll getSiteSitemap until running is false. Answering 200 here would be the status-code equivalent of telling the customer their sitemap is ready. upload writes sitemap.xml into the webspace, overwriting any existing file. Requires sites.panel_access.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`siteId (path)`	`Uuid`	Так	Site ID (UUIDv7).

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`frequency`	`string<always, hourly, daily, weekly, monthly, never, yearly>`	Ні	The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee.
`upload`	`boolean`	Ні	Overwrite `sitemap.xml` in the webspace when the crawl finishes.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`ever_run`	`boolean`	Так	Has a crawl ever been run for this site?
`running`	`boolean`	Так	Is a crawl in progress? ⛔ Computed as not in a terminal state, so a state we have never seen reads as still working rather than as finished.
`state`	`string`	Так	The vendor's own job state, verbatim. Empty when none has run.
`created_at`	`string`	Так	When the most recent crawl started. Empty when none has run.
`output`	`string`	Так	The crawler's own output, if it produced any.
`upload`	`boolean`	Так	Whether the crawl writes `sitemap.xml` into the webspace.
`frequencies`	`string[]`	Так	The change frequencies this site's crawler accepts.

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/sitemap