hosting

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

Tell us where this site's posts should go.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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>> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`siteId (path)`	`string`	Sim	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`kind`	`string<wordpress, headless_rest, git_static>`	Sim	—
`preset`	`string<, payload, strapi, directus, ghost, shopify, webflow, custom>`	Não	—
`base_url`	`string`	Não	—
`collection`	`string`	Não	—
`auth_scheme`	`string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>`	Não	—
`auth_header`	`string`	Não	—
`field_map`	`object`	Não	—
`enabled`	`boolean`	Não	—
`secret`	`string`	Não	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…

Resposta

Nome	Tipo	Obrigatório	O que é
`site_id`	`string`	Sim	—
`kind`	`string<, wordpress, headless_rest, git_static>`	Sim	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, becau…
`preset`	`string<, payload, strapi, directus, ghost, shopify, webflow, custom>`	Sim	—
`base_url`	`string`	Sim	The CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
`collection`	`string`	Sim	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>`	Sim	—
`auth_header`	`string`	Sim	For the `header` auth scheme — which header the key is sent in.
`field_map`	`object`	Sim	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`	Sim	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`	Sim	—
`capabilities`	`string[]`	Sim	—
`detected_identity`	`string`	Sim	What the destination said it was, last time it answered.
`last_probe_at`	`string`	Sim	—
`last_probe_reachable`	`boolean`	Sim	⛔ `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`	Sim	—
`last_probe_detail`	`string`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

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