hosting

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

Tell us where this site's posts should go.

Svi hosting krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

NazivVrstaObaveznoŠto je to
siteId (path)stringDa

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
kindstring<wordpress, headless_rest, git_static>Da
presetstring<, payload, strapi, directus, ghost, shopify, webflow, custom>Ne
base_urlstringNe
collectionstringNe
auth_schemestring<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>Ne
auth_headerstringNe
field_mapobjectNe
enabledbooleanNe
secretstringNeThe 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…

Odgovor

NazivVrstaObaveznoŠto je to
site_idstringDa
kindstring<, wordpress, headless_rest, git_static>DaEmpty 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…
presetstring<, payload, strapi, directus, ghost, shopify, webflow, custom>Da
base_urlstringDaThe CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
collectionstringDaThe 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_schemestring<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>Da
auth_headerstringDaFor the header auth scheme — which header the key is sent in.
field_mapobjectDaRenames, 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…
enabledbooleanDaA 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_credentialbooleanDa
capabilitiesstring[]Da
detected_identitystringDaWhat the destination said it was, last time it answered.
last_probe_atstringDa
last_probe_reachablebooleanDanull 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_codestringDa
last_probe_detailstringDa

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422