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