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 कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव 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