hosting

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

Start a sitemap crawl.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.panel_access; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

⛔ **`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`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`siteId (path)`	`Uuid`	Sim	Site ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`frequency`	`string<always, hourly, daily, weekly, monthly, never, yearly>`	Não	The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee.
`upload`	`boolean`	Não	Overwrite `sitemap.xml` in the webspace when the crawl finishes.

Resposta

Nome	Tipo	Obrigatório	O que é
`ever_run`	`boolean`	Sim	Has a crawl ever been run for this site?
`running`	`boolean`	Sim	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`	Sim	The vendor's own job state, verbatim. Empty when none has run.
`created_at`	`string`	Sim	When the most recent crawl started. Empty when none has run.
`output`	`string`	Sim	The crawler's own output, if it produced any.
`upload`	`boolean`	Sim	Whether the crawl writes `sitemap.xml` into the webspace.
`frequencies`	`string[]`	Sim	The change frequencies this site's crawler accepts.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/sitemap