hosting

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

Tell us where this site's posts should go.

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`siteId (path)`	`string`	Tak	—

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`kind`	`string<wordpress, headless_rest, git_static>`	Tak	—
`preset`	`string<, payload, strapi, directus, ghost, shopify, webflow, custom>`	Nie	—
`base_url`	`string`	Nie	—
`collection`	`string`	Nie	—
`auth_scheme`	`string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>`	Nie	—
`auth_header`	`string`	Nie	—
`field_map`	`object`	Nie	—
`enabled`	`boolean`	Nie	—
`secret`	`string`	Nie	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…

Odpowiedź

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

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422

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