hosting
PUT /v1/sites/{siteId}/cms-target
Tell us where this site's posts should go.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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>> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
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.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | string | はい | — |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
kind | string<wordpress, headless_rest, git_static> | はい | — |
preset | string<, payload, strapi, directus, ghost, shopify, webflow, custom> | いいえ | — |
base_url | string | いいえ | — |
collection | string | いいえ | — |
auth_scheme | string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header> | いいえ | — |
auth_header | string | いいえ | — |
field_map | object | いいえ | — |
enabled | boolean | いいえ | — |
secret | string | いいえ | 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… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
site_id | string | はい | — |
kind | string<, wordpress, headless_rest, git_static> | はい | 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> | はい | — |
base_url | string | はい | The CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository). |
collection | string | はい | 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> | はい | — |
auth_header | string | はい | For the header auth scheme — which header the key is sent in. |
field_map | object | はい | 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 | はい | 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 | はい | — |
capabilities | string[] | はい | — |
detected_identity | string | はい | What the destination said it was, last time it answered. |
last_probe_at | string | はい | — |
last_probe_reachable | boolean | はい | ⛔ 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 | はい | — |
last_probe_detail | string | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422