hosting
GET /v1/sites/{siteId}/sitemap
The site's most recent sitemap crawl.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
ever_run and running are separate on purpose: "you have never generated one" and "the last one finished" are different sentences to a customer and would be the same falsy value in a flatter shape. Requires sites.view. 404 for a site with no managed hosting package.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
siteId (path) | Uuid | Tak | Site ID (UUIDv7). |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
ever_run | boolean | Tak | Has a crawl ever been run for this site? |
running | boolean | Tak | 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 | Tak | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Tak | When the most recent crawl started. Empty when none has run. |
output | string | Tak | The crawler's own output, if it produced any. |
upload | boolean | Tak | Whether the crawl writes sitemap.xml into the webspace. |
frequencies | string[] | Tak | The change frequencies this site's crawler accepts. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 429 · 503