hosting

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

Start a sitemap crawl.

ప్రమాణీకరణ

బీయర్ టోకెన్‌గా API కీని పంపండి. కీ తప్పనిసరిగా 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 ద్వారా ఆభ్యర్థనను రన్ చేస్తుంది. ఈ ఎండ్‌పాయింట్‌ను 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