hosting

PUT `/v1/sites/{siteId}/cms-target`

Tell us where this site's posts should go.

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/cms-target \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "kind": <string<wordpress, headless_rest, git_static>> }'

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

Подробнее

Creates or replaces the site's content target. Gated on links.edit. ⛔ secret is write-only, and omitting it keeps the credential you already have rather than clearing it — a customer editing a collection name must not silently delete their key. The secret is written to Vault before the row is saved, and the row is only written if that succeeded: the other order leaves a row that reads as configured on every screen and fails at the first publish.

Параметры

Имя	Тип	Обязательно	Что это
`siteId (path)`	`string`	Да	—

Тело запроса

Имя	Тип	Обязательно	Что это
`kind`	`string<wordpress, headless_rest, git_static>`	Да	—
`preset`	`string<, payload, strapi, directus, ghost, shopify, webflow, custom>`	Нет	—
`base_url`	`string`	Нет	—
`collection`	`string`	Нет	—
`auth_scheme`	`string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>`	Нет	—
`auth_header`	`string`	Нет	—
`field_map`	`object`	Нет	—
`enabled`	`boolean`	Нет	—
`secret`	`string`	Нет	The API key. ⛔ Write-only, and omitting it keeps the credential you already have rather than clearing it. It is written to Vault before the row is saved, and the row is only…

Ответ

Имя	Тип	Обязательно	Что это
`site_id`	`string`	Да	—
`kind`	`string<, wordpress, headless_rest, git_static>`	Да	Empty when nothing claims this site. For a site with no configured row this is the derived target — most WordPress sites on our own fleet need no configuration at all, because…
`preset`	`string<, payload, strapi, directus, ghost, shopify, webflow, custom>`	Да	—
`base_url`	`string`	Да	The CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
`collection`	`string`	Да	The collection posts are created in — `posts` on Payload, a blog id on Shopify, a collection id on Webflow, the content directory on a Git target.
`auth_scheme`	`string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>`	Да	—
`auth_header`	`string`	Да	For the `header` auth scheme — which header the key is sent in.
`field_map`	`object`	Да	Renames, for a destination that spells our fields differently. ⛔ It renames; it never adds a capability. A field map cannot make a target able to carry a tag it has no field…
`enabled`	`boolean`	Да	A disabled target is skipped and reads as `needs_setup` — kept rather than deleted so pausing publishing to a site does not lose its set-up.
`has_credential`	`boolean`	Да	—
`capabilities`	`string[]`	Да	—
`detected_identity`	`string`	Да	What the destination said it was, last time it answered.
`last_probe_at`	`string`	Да	—
`last_probe_reachable`	`boolean`	Да	⛔ `null` means never probed; `false` means probed and could not be reached. Those are different facts and a client must not render them the same.
`last_probe_code`	`string`	Да	—
`last_probe_detail`	`string`	Да	—

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422

PUT /v1/sites/{siteId}/cms-target