API key を作る
- n8n を開きます。
- Settings へ進みます。
- n8n API のセクションを開きます。
- Create an API key を選びます。
- key をコピーします。多くのバージョンでは 1 回しか表示されません。
手順は n8n Cloud でも self-hosted でも同じです。key は作成したアカウントの権限を継ぐので、監視したい workflow が見えて、それ以上は見えないアカウントから作るのが安全です。
instance の 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 が読むもの
- workflow
- 名前、有効かどうか、trigger node とその schedule、node 名と種類、設定変更の検出に使う定義のハッシュ。
- execution
- status、開始と終了の時刻、所要時間、mode、最後に実行された node、最終 node の件数、秘密情報を除去したエラー文。
execution の payload は保存しません。直近の実行について、件数と最後の node を把握できる範囲まで読み、残すのは要約だけです。
OutcomeGuard がしないこと
- workflow の作成、編集、インポート、有効化、無効化。
- n8n 内の credential の読み取り、作成、変更。
- お客様の workflow の実行。
- instance の設定、ユーザー、権限の変更。
key のローテーションと停止
ローテーションする場合：n8n で新しい key を作り、ダッシュボードの連携に貼り、そのあと n8n 側で古い key を削除します。新しい key は置き換える前に検証するため、監視が途切れません。
完全に止める場合：n8n 側で key を削除するか、ダッシュボードで連携を解除します。解除すると、その連携の credential と execution 要約を削除します。
接続エラーの意味
- unauthorized
- n8n が key を拒否しました。コピーが途中で切れている、key が削除されている、key を持つアカウントが権限を失った、のいずれかです。新しい key を作り直してください。
- unreachable
- ホストが応答しません。URL、DNS、n8n の前段にあるファイアウォールや認証プロキシを確認してください。独自の認証を要求するリバースプロキシでもこれになります。
- invalid_url
- URL を解析できない、または https:// が付いていません。パスなしのベース URL を使ってください。
- private_url_blocked
- プライベートネットワーク上のアドレスです。ホスト型のスキャナからは到達できません。HTTPS で公開するか、ネットワーク内部から監視してください。
- rate_limited
- instance 側でレート制限がかかっています。OutcomeGuard は間隔を空けて再試行します。続く場合は、前段のプロキシや WAF のレート制限を確認してください。
instance に到達できない間、その workflow は UNKNOWN として扱います。データがないことから健康を推測することはありません。