hosting

POST /v1/sites/{siteId}/sitemap

Start a sitemap crawl.

બધા hosting એન્ડપૉઇન્ટ્સ

પ્રમાણીકરણ

એપીઆઈ કી (API key) ને બેરર ટોકન તરીકે મોકલો. કી પાસે sites.panel_access પરવાનગી હોવી આવશ્યક છે; તેના વગરની કીને 404 ને બદલે 403 સાથે અસ્વીકાર કરવામાં આવશે.

આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.

આયમાવો

કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.

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).

રિકવેસ્ટ બોડી

નામપ્રકારજરૂરીતે શું છે
frequencystring<always, hourly, daily, weekly, monthly, never, yearly>નાThe `changefreq` written into the generated XML. A guideline to search engines, not a guarantee.
uploadbooleanનાOverwrite `sitemap.xml` in the webspace when the crawl finishes.

જવાબ

નામપ્રકારજરૂરીતે શું છે
ever_runbooleanહાHas a crawl ever been run for this site?
runningbooleanહા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.
statestringહાThe vendor's own job state, verbatim. Empty when none has run.
created_atstringહાWhen the most recent crawl started. Empty when none has run.
outputstringહાThe crawler's own output, if it produced any.
uploadbooleanહાWhether the crawl writes `sitemap.xml` into the webspace.
frequenciesstring[]હાThe change frequencies this site's crawler accepts.

આ એન્ડપોઇન્ટ જે ભૂલો પરત કરી શકે છે

401 · 403 · 404 · 422 · 429 · 503