メインコンテンツまでスキップ

カスタムドメイン

既定では文書は Powerduck の共有アドレスから提供されます。カスタムドメインは、共有リンクではなくあなた自身のホスト名でドキュメントと MCP を表示し、ブランドで API を公開する上で重要です。

カスタムドメインは有料機能で、Pro と Team プランで利用できます(oas.custom_domain 権益で確認)。

ホスト全体紐づけとサブパス紐づけ​

紐づけは以下を対象にできます。

  • ホスト全体——api.example.com がルートで 1 文書を提供。
  • ホストとサブパス——example.com/v1 が /v1 配下で 1 文書を提供。

サブパス紐づけで、1 ホスト名が複数文書を提供できます。

example.com/v1 -> document A
example.com/v2 -> document B

これにより文書ごとに 1 ホスト名しか使えない制限を避け、バージョン付きベースパスを支えます。

カスタムドメイン上​

共有アドレスで利用可能な同じモードが、紐づきドメイン配下に短く安定したパスで提供されます。

モードホスト全体サブパス
現在仕様/oas/v1/oas
バージョン固定仕様/v/:version/oas/v1/v/:version/oas
MCP/mcp/v1/mcp

ホストはリクエストのホスト名とパスから解決し、紐づき文書へルーティングします。これらのパスは CORS プリフライトを処理します。

ドメインを追加し検証する​

所有権検証前はドメインが信頼されないため、フローは明確です。

  1. 文書にホスト名(またはホスト名とパス)を追加。
  2. サービスが紐づきと DNS 指示を返す。
  3. DNS 記録を作り検証する。
  4. 紐づきが保留から検証済みに変わり提供開始。

所有権確認は TXT 記録を使います。

フィールド値
記録タイプTXT
ホスト_powerduck-challenge.<your-domain>
值powerduck-verify=<verification-token>

検証は DNS から TXT 記録を読み、定数時間マッチでトークンを比較します。検証済み紐づきは検証済みのままで、再確認不要です。

例​

api.example.com 向けに TXT 記録を追加します。

_powerduck-challenge.api.example.com
TXT "powerduck-verify=<the-token-shown-for-the-binding>"

その後、文書ワークスペースで検証を選びます。検証済みと報告されると、文書と MCP がそのドメインから提供されます(文書アクティブかつ各モード有効が前提)。

紐づきを管理​

  • 文書に紐づくドメインを一覧。状態とベースパスを含む。
  • DNS 記録追加後に保留紐づきを検証。
  • 紐づきを削除し、そのドメインからの提供を停止。

アクセスマーカー変更はキャッシュされたホスト解決を無効化するため、更新が即時反映し古い紐づきを提供しません。

アクセス制御は引き続き適用​

カスタムドメインは追加アドレスであってバイパスではありません。同じゲートが適用されます。

  • 文書は ACTIVE でなければならない。
  • ドキュメントと MCP に各有効マーカー。
  • 閲覧パスワードがドキュメントを、MCP アクセスキーが MCP を引き続き保護。

アクセス制御をご覧ください。

関連: 文書とバージョン、請求。