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 കൺസോൾ നിങ്ങളുടെ യഥാർത്ഥ ഓർഗനൈസേഷൻ ഐഡിയും നിങ്ങളുടെ സ്വന്തം കീയും പൂരിപ്പിക്കുകയും, യഥാർത്ഥ പ്രതികരണം (response) നിങ്ങൾക്ക് കാണുന്നതിനായി ലൈവ് API-ലേക്ക് അഭ്യർത്ഥന (request) പ്രവർത്തിപ്പിക്കുകയും ചെയ്യുന്നു. ഈ എൻഡ്പോയിന്റ് 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