hosting

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

Start a sitemap crawl.

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione sites.panel_access; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`siteId (path)`	`Uuid`	Sì	Site ID (UUIDv7).

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`frequency`	`string<always, hourly, daily, weekly, monthly, never, yearly>`	No	The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee.
`upload`	`boolean`	No	Overwrite `sitemap.xml` in the webspace when the crawl finishes.

Risposta

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

Errori che questo endpoint può restituire

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/sitemap