hosting
GET /v1/sites/{siteId}/sitemap
The site's most recent sitemap crawl.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.view; 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 GET https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…"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
`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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
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 · 429 · 503