hosting

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

Start a sitemap crawl.

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar sites.panel_access iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`siteId (path)`	`Uuid`	Evet	Site ID (UUIDv7).

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`frequency`	`string<always, hourly, daily, weekly, monthly, never, yearly>`	Hayır	The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee.
`upload`	`boolean`	Hayır	Overwrite `sitemap.xml` in the webspace when the crawl finishes.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`ever_run`	`boolean`	Evet	Has a crawl ever been run for this site?
`running`	`boolean`	Evet	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`	Evet	The vendor's own job state, verbatim. Empty when none has run.
`created_at`	`string`	Evet	When the most recent crawl started. Empty when none has run.
`output`	`string`	Evet	The crawler's own output, if it produced any.
`upload`	`boolean`	Evet	Whether the crawl writes `sitemap.xml` into the webspace.
`frequencies`	`string[]`	Evet	The change frequencies this site's crawler accepts.

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/sitemap