hosting

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

Check the credential actually works, against the real CMS.

Усі кінцеві точки hosting

Уся документація для розробників

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/cms-target/test \
  -H "Authorization: Bearer zdk_live_…"

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Параметри

НазваТипОбов'язковеЩо це таке
siteId (path)stringТак

Відповідь

НазваТипОбов'язковеЩо це таке
site_idstringТак
reachablebooleanТак
identitystringТак
codestringТак
detailstringТак
suitabilitystring<ready, needs_setup, unknown, unsuitable, blocked>Так

Помилки, які може повертати ця кінцева точка

401 · 403 · 404