hosting

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

Start a sitemap crawl.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya sites.panel_access; ufunguo usio nayo unakataliwa kwa 403, si 404.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`siteId (path)`	`Uuid`	Ndiyo	Site ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`frequency`	`string<always, hourly, daily, weekly, monthly, never, yearly>`	Hapana	The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee.
`upload`	`boolean`	Hapana	Overwrite `sitemap.xml` in the webspace when the crawl finishes.

Majibu

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

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/sitemap