Skip to content
OutcomeGuard
Menu
All docs

Connecting n8n

API keys, URLs, permissions and connection troubleshooting.

Create an API key

  1. Open n8n.
  2. Go to Settings.
  3. Open the n8n API section.
  4. Choose Create an API key.
  5. Copy the key — most n8n versions show it only once.

This works the same way on n8n Cloud and on self-hosted instances. The key inherits the permissions of the account that created it, so create it from an account that can see the workflows you want monitored and nothing more.

The instance URL

Use the base URL you open n8n at, without a path:

https://n8n.example.com
https://example.app.n8n.cloud
  • HTTPS is required.
  • The host must be reachable from the internet for the hosted scan and for hosted monitoring.
  • Private addresses — localhost, 10.x, 172.16–31.x, 192.168.x, link-local and .internal hostnames — are rejected rather than probed.
  • Do not include /api/v1 or any other path. OutcomeGuard appends the API paths itself.

What OutcomeGuard reads

Workflows
Name, active flag, trigger nodes and their schedules, node names and types, and a hash of the definition used to detect drift.
Executions
Status, start and stop time, duration, mode, the last node executed, the item count of the final node, and error text with secrets redacted.

Execution payloads are not stored. OutcomeGuard reads enough of a recent execution to count items and identify the terminal node, and keeps only the summary.

What OutcomeGuard never does

  • Create, edit, import, activate or deactivate a workflow.
  • Read, create or change credentials inside n8n.
  • Trigger an execution of your workflows.
  • Change instance settings, users or permissions.

Rotating or revoking the key

To rotate: create a new key in n8n, paste it into the integration in the dashboard, then delete the old key in n8n. Monitoring continues without a gap because the new key is verified before it replaces the old one.

To stop completely: delete the key in n8n, or disconnect the integration in the dashboard. Disconnecting removes the stored credential and the execution summaries belonging to that integration.

Connection errors and what they mean

unauthorized
n8n rejected the key. It was truncated when copied, it was deleted, or the account that owns it lost access. Create a new key and paste it again.
unreachable
The host did not answer. Check the URL, DNS, and whether a firewall or access proxy sits in front of n8n. A reverse proxy that requires its own authentication will also produce this.
invalid_url
The URL could not be parsed, or it is missing https://. Use the base URL with no path.
private_url_blocked
The address is on a private network. A hosted scanner cannot reach it. Expose the instance over HTTPS, or monitor it from inside the network.
rate_limited
The instance is rate limiting requests. OutcomeGuard backs off and retries; if it persists, check any proxy or WAF rate limits in front of n8n.

While an instance is unreachable, its workflows are reported as UNKNOWN. OutcomeGuard does not infer that a workflow is healthy from the absence of data.