hosting

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

The site's most recent sitemap crawl.

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

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

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

Спробувати

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

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
  -H "Authorization: Bearer zdk_live_…"

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

Деталі

ever_run and running are separate on purpose: "you have never generated one" and "the last one finished" are different sentences to a customer and would be the same falsy value in a flatter shape. Requires sites.view. 404 for a site with no managed hosting package.

Параметри

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

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`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 · 429 · 503

GET /v1/sites/{siteId}/sitemap