hosting
GET /v1/sites/{siteId}/sitemap
The site's most recent sitemap crawl.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
`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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
ever_run | boolean | Oui | Has a crawl ever been run for this site? |
running | boolean | Oui | 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 | Oui | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Oui | When the most recent crawl started. Empty when none has run. |
output | string | Oui | The crawler's own output, if it produced any. |
upload | boolean | Oui | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | Oui | The change frequencies this site's crawler accepts. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429 · 503