hosting

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

Start a sitemap crawl.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د sites.panel_access اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`siteId (path)`	`Uuid`	هو	Site ID (UUIDv7).

د غوښتنې بدن

نوم	ډول	اړین	دا څه شی دی
`frequency`	`string<always, hourly, daily, weekly, monthly, never, yearly>`	نه	The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee.
`upload`	`boolean`	نه	Overwrite `sitemap.xml` in the webspace when the crawl finishes.

ځواب

نوم	ډول	اړین	دا څه شی دی
`ever_run`	`boolean`	هو	Has a crawl ever been run for this site?
`running`	`boolean`	هو	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`	هو	The vendor's own job state, verbatim. Empty when none has run.
`created_at`	`string`	هو	When the most recent crawl started. Empty when none has run.
`output`	`string`	هو	The crawler's own output, if it produced any.
`upload`	`boolean`	هو	Whether the crawl writes `sitemap.xml` into the webspace.
`frequencies`	`string[]`	هو	The change frequencies this site's crawler accepts.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/sitemap