hosting

POST /v1/sites/{siteId}/cms-target/test

Check the credential actually works, against the real CMS.

Tous les points de terminaison hosting

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

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 POST https://api.zinndigital.com/v1/sites/{siteId}/cms-target/test \
  -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

Contacts the site's CMS with the stored credential and records what happened. Gated on `links.edit`. ⭐ **This is what promotes a target from "configured" to "ready".** A preset we shipped from a vendor's documentation is a claim; a probe against the customer's own instance is a measurement, and nothing in the picker reads green until this has answered. ⛔ A failure here is a 200 carrying `reachable: false` and a reason, not an error status. "We could not reach it" is the answer to the question that was asked.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
siteId (path)stringOui

Réponse

NomTypeObligatoireQu'est-ce que c'est
site_idstringOui
reachablebooleanOui
identitystringOui
codestringOui
detailstringOui
suitabilitystring<ready, needs_setup, unknown, unsuitable, blocked>Oui

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404