hosting
GET /v1/sites/{siteId}/sitemap
The site's most recent sitemap crawl.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.view; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429 · 503