認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/domains \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The registered/connected domains in scope. Cursor-paginated, RLS-scoped. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
X-Zinn-Org (header) | string | いいえ | **Which organisation this call acts for.** Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything… |
cursor (query) | string | いいえ | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | いいえ | Maximum items to return (page size). |
status (query) | DomainStatus | いいえ | Filter by domain lifecycle status. |
org_id (query) | Uuid | いいえ | Restrict to one organization in scope. |
tld (query) | string | いいえ | Filter by TLD (e.g. `com`). |
site_id (query) | Uuid | いいえ | Restrict to the domain backing one site — the link a site's DNS screen follows to reach the zone it should edit. Scoped by the same RLS filter as everything else here, so a site… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | Domain[] | はい | — |
page | PageMeta | はい | — |
このエンドポイントが返すエラー
401 · 403 · 422 · 429