hosting

GET /v1/sites/{siteId}/sitemap

The site's most recent sitemap crawl.

Все эндпоинты hosting

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

Отправьте ключ 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_runbooleanДаHas a crawl ever been run for this site?
runningbooleanДа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.
statestringДаThe vendor's own job state, verbatim. Empty when none has run.
created_atstringДаWhen the most recent crawl started. Empty when none has run.
outputstringДаThe crawler's own output, if it produced any.
uploadbooleanДаWhether the crawl writes `sitemap.xml` into the webspace.
frequenciesstring[]ДаThe change frequencies this site's crawler accepts.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 429 · 503