hosting

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

Start a sitemap crawl.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს sites.panel_access ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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