hosting
POST /v1/sites/{siteId}/cms-target/test
Check the credential actually works, against the real CMS.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/cms-target/test \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
siteId (path) | string | Ano | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
site_id | string | Ano | — |
reachable | boolean | Ano | — |
identity | string | Ano | — |
code | string | Ano | — |
detail | string | Ano | — |
suitability | string<ready, needs_setup, unknown, unsuitable, blocked> | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404