hosting

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

Start a sitemap crawl.

प्रमाणीकरण

बेरर टोकन म्हणून API की पाठवा. की मध्ये sites.panel_access परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.

या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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

साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील 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