ai

GET /v1/ai/site-builds/targets

Where a draft can be published, and what is already on each destination.

すべての ai エンドポイント

認証

ベアラー トークンとして API キーを送信します。キーには hosting.deploy.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/ai/site-builds/targets \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Lists every site the caller may deploy to, and — the part that did not exist before — **what is already there**. Publishing used to take a site id with no way to discover which ids were valid, and no way to learn that a destination had a live business on it. `occupancy` is the field to read, never `known_files`: * `empty` — nothing is deployed. Publishing here destroys nothing. * `ours` — we published the current contents ourselves, from an earlier draft. * `occupied` — something is there and we can read it, because the site has a connected repository. * `unknown` — something may be there and we **cannot** read it. This is deliberately not reported as `empty`: an empty destination is precisely the one where overwriting is safe, so the two must never collapse. A destination we cannot read offers `replace` only, and the customer is told to connect a repository if they want to add to it instead. `allowed_dispositions` is advisory — the screen uses it to decide which buttons to show, and the engine re-derives it when a publication is started. A client that offers a disposition this list omits is refused with `disposition_not_available`. Requires `hosting.deploy.manage`, even though this only reads: the list is "places you may publish to", and offering a destination the caller cannot use both answers the wrong question and discloses sites they may only view.

パラメータ

名前タイプ必須これがその内容です
search (query)stringいいえMatch against the destination's primary domain.

返信

名前タイプ必須これがその内容です
targetsSiteMakerTarget[]はい
truncatedbooleanはい`true` when `targets` is a full page and more destinations exist beyond it. The list is ordered by hostname and capped, so a site that sorts past the cap is absent rather than l…
dispositionsobject[]はいThe catalogue, so a client never hardcodes the choices and adding one cannot leave a stale copy behind.

このエンドポイントが返すエラー

401 · 403 · 429