API キーを作る
- n8n を開きます。
- Settings へ進みます。
- n8n API のセクションを開きます。
- Create an API key を選びます。
- キーをコピーします。多くのバージョンでは 1 回しか表示されません。
手順は n8n Cloud でもセルフホストでも同じです。キーは作成したアカウントの権限を継ぐので、監視したいワークフローが見えて、それ以上は見えないアカウントから作るのが安全です。
インスタンスの URL
n8n を開くときのベース URL を、パスなしで指定します。
https://n8n.example.com
https://example.app.n8n.cloud- HTTPS が必要です。
- 無料スキャンでも継続監視でも、インターネットから接続できる必要があります。
- プライベートなアドレス（localhost、10.x、172.16〜31.x、192.168.x、link-local、.internal のホスト名）は、接続を試す前に拒否します。
- /api/v1 などのパスは付けないでください。API のパスは OutcomeGuard 側で付けます。
OutcomeGuard が読むもの
- ワークフロー
- 名前、有効かどうか、トリガーノードとそのスケジュール、ノード名と種類、設定変更の検出に使う定義のハッシュ。
- 実行
- 状態、開始と終了の時刻、所要時間、実行モード、最後に実行されたノード、最後のノードの件数、秘密情報を取り除いたエラー文。
実行のペイロードは保存しません。直近の実行について、件数と最後のノードを把握できる範囲まで読み、残すのは要約だけです。
OutcomeGuard がしないこと
- ワークフローの作成、編集、インポート、有効化、無効化。
- n8n 内の認証情報の読み取り、作成、変更。
- お客様のワークフローの実行。
- インスタンスの設定、ユーザー、権限の変更。
キーのローテーションと停止
ローテーションする場合：n8n で新しいキーを作り、ダッシュボードの連携に貼り、そのあと n8n 側で古いキーを削除します。新しいキーは置き換える前に検証するため、監視が途切れません。
完全に止める場合：n8n 側でキーを削除するか、ダッシュボードで連携を解除します。解除すると、その連携の認証情報と実行の要約を削除します。
接続エラーの意味
- unauthorized
- n8n がキーを拒否しました。コピーが途中で切れている、キーが削除されている、キーを持つアカウントが権限を失った、のいずれかです。新しいキーを作り直してください。
- unreachable
- ホストが応答しません。URL、DNS、n8n の前段にあるファイアウォールや認証プロキシを確認してください。独自の認証を要求するリバースプロキシでもこれになります。
- invalid_url
- URL を解析できない、または https:// が付いていません。パスなしのベース URL を使ってください。
- private_url_blocked
- プライベートネットワーク上のアドレスです。OutcomeGuard からは接続できません。HTTPS で公開するか、ネットワークの内側から監視してください。
- rate_limited
- インスタンス側でレート制限がかかっています。OutcomeGuard は間隔を空けて再試行します。続く場合は、前段のプロキシや WAF のレート制限を確認してください。
インスタンスに接続できない間、そのワークフローは UNKNOWN として扱います。データがないことを正常とはみなしません。