hosting

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

Start a sitemap crawl.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.panel_access; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

Název	Typ	Požadováno	Co to je
`siteId (path)`	`Uuid`	Ano	Site ID (UUIDv7).

Tělo požadavku

Název	Typ	Požadováno	Co to je
`frequency`	`string<always, hourly, daily, weekly, monthly, never, yearly>`	Ne	The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee.
`upload`	`boolean`	Ne	Overwrite `sitemap.xml` in the webspace when the crawl finishes.

Odpověď

Název	Typ	Požadováno	Co to je
`ever_run`	`boolean`	Ano	Has a crawl ever been run for this site?
`running`	`boolean`	Ano	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`	Ano	The vendor's own job state, verbatim. Empty when none has run.
`created_at`	`string`	Ano	When the most recent crawl started. Empty when none has run.
`output`	`string`	Ano	The crawler's own output, if it produced any.
`upload`	`boolean`	Ano	Whether the crawl writes `sitemap.xml` into the webspace.
`frequencies`	`string[]`	Ano	The change frequencies this site's crawler accepts.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/sitemap