hosting

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

Tell us where this site's posts should go.

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`siteId (path)`	`string`	Sì	—

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`kind`	`string<wordpress, headless_rest, git_static>`	Sì	—
`preset`	`string<, payload, strapi, directus, ghost, shopify, webflow, custom>`	No	—
`base_url`	`string`	No	—
`collection`	`string`	No	—
`auth_scheme`	`string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>`	No	—
`auth_header`	`string`	No	—
`field_map`	`object`	No	—
`enabled`	`boolean`	No	—
`secret`	`string`	No	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…

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`site_id`	`string`	Sì	—
`kind`	`string<, wordpress, headless_rest, git_static>`	Sì	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>`	Sì	—
`base_url`	`string`	Sì	The CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
`collection`	`string`	Sì	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>`	Sì	—
`auth_header`	`string`	Sì	For the `header` auth scheme — which header the key is sent in.
`field_map`	`object`	Sì	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`	Sì	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`	Sì	—
`capabilities`	`string[]`	Sì	—
`detected_identity`	`string`	Sì	What the destination said it was, last time it answered.
`last_probe_at`	`string`	Sì	—
`last_probe_reachable`	`boolean`	Sì	⛔ `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`	Sì	—
`last_probe_detail`	`string`	Sì	—

Errori che questo endpoint può restituire

401 · 403 · 404 · 422

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