hosting

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

Tell us where this site's posts should go.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`siteId (path)`	`string`	Igen	—

Kérés törzse

Név	Típus	Kötelező	Mi ez
`kind`	`string<wordpress, headless_rest, git_static>`	Igen	—
`preset`	`string<, payload, strapi, directus, ghost, shopify, webflow, custom>`	Nem	—
`base_url`	`string`	Nem	—
`collection`	`string`	Nem	—
`auth_scheme`	`string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>`	Nem	—
`auth_header`	`string`	Nem	—
`field_map`	`object`	Nem	—
`enabled`	`boolean`	Nem	—
`secret`	`string`	Nem	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…

Válasz

Név	Típus	Kötelező	Mi ez
`site_id`	`string`	Igen	—
`kind`	`string<, wordpress, headless_rest, git_static>`	Igen	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>`	Igen	—
`base_url`	`string`	Igen	The CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
`collection`	`string`	Igen	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>`	Igen	—
`auth_header`	`string`	Igen	For the `header` auth scheme — which header the key is sent in.
`field_map`	`object`	Igen	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`	Igen	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`	Igen	—
`capabilities`	`string[]`	Igen	—
`detected_identity`	`string`	Igen	What the destination said it was, last time it answered.
`last_probe_at`	`string`	Igen	—
`last_probe_reachable`	`boolean`	Igen	⛔ `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`	Igen	—
`last_probe_detail`	`string`	Igen	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422

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