hosting
POST /v1/sites/{siteId}/sitemap
Start a sitemap crawl.
Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu sites.panel_access; ključ bez nje se odbija s kodom 403, a ne 404.
Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
⛔ 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.
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
siteId (path) | Uuid | Da | Site ID (UUIDv7). |
Tijelo zahtjeva
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | Ne | The changefreq written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | Ne | Overwrite sitemap.xml in the webspace when the crawl finishes. |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
ever_run | boolean | Da | Has a crawl ever been run for this site? |
running | boolean | Da | 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 | Da | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Da | When the most recent crawl started. Empty when none has run. |
output | string | Da | The crawler's own output, if it produced any. |
upload | boolean | Da | Whether the crawl writes sitemap.xml into the webspace. |
frequencies | string[] | Da | The change frequencies this site's crawler accepts. |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 404 · 422 · 429 · 503