> ## Documentation Index
> Fetch the complete documentation index at: https://support.configview.com/llms.txt
> Use this file to discover all available pages before exploring further.

# n8n setup

Configview reads your n8n instance (the workflow automation platform, n8n Cloud or self-hosted) through the n8n **public REST API** (`<your instance>/api/v1`), using an **API key** created in n8n. Configview only reads. The one `POST` it makes, to `/audit`, generates n8n's built-in security report and changes nothing.

You will end up with **2 required secrets** (`N8N_BASE_URL`, `N8N_API_KEY`) and **1 optional secret** (`N8N_ALLOW_HTTP`) in Configview when setup is complete.

> **Scope of this integration today.** Configview answers "who can build and run automations here, which other systems does n8n hold logins for, and which automations are active, failing or idle": users and roles, projects and project members, workflows (name, owner, tags, active or archived), per-workflow run and failure counts, credentials metadata (name, service type, owner, age), variable names and the security audit summary. It does **not** read workflow contents (nodes, connections, settings, pinned data), execution data, credential secrets, variable values or webhook URLs.

***

## What you need

* An n8n instance on a plan that includes the public API (Cloud Starter, Pro or Enterprise; any self-hosted edition; not the free trial)
* Sign in as the **instance owner or an admin**: the users and credentials lists are only available to them
* The instance address, for example `https://acme.app.n8n.cloud` or `https://n8n.example.com`

***

## Step 1: Open the n8n page in Configview

Open Configview in a second browser tab and leave it open:

`https://{companyname}.configview.com/admin/integrations/n8n`

***

## Step 2: Create the API key

1. In n8n open **Settings > n8n API** and click **Create an API key**
2. Give it a label such as `Configview` and an expiration you can track (put the date on your calendar; a collector fails with 401 once the key expires)
3. Choose the scopes. On n8n 2.14 or later grant **only** these read scopes:

| Scope | Used for |
| - | - |
| `user:list` | Users, project members |
| `project:list` | Projects |
| `workflow:list` | Workflows |
| `execution:list` | Per-workflow run and failure counts |
| `credential:list` | Credential metadata |
| `variable:list` | Variable names |
| `securityAudit:generate` | Security audit summary |

Before n8n 2.14, scopes are an Enterprise feature and every key has full access. Create the key as the owner or an admin and treat it as sensitive.
4\. In the Configview tab paste the instance address into `N8N_BASE_URL` and the key into `N8N_API_KEY` under **Credentials**, and save

`https` is required. For a self-hosted instance on a private network without TLS only, also set `N8N_ALLOW_HTTP` to `true`. A trailing `/api/v1` on the address is accepted.

***

## Step 3: Connect and verify

1. Click **Connect**. Configview creates its tables and schedules every collector at your default run time:

| Script | Notes |
| - | - |
| **Users** | Email, global role, pending invitation, MFA. Needs an owner or admin key. |
| **Projects** | Team and personal projects. |
| **Project members** | Members and project roles of each team project. |
| **Workflows** | Name, active, archived, tags, owner project. |
| **Workflow runs** | Runs and failures per workflow over 7 and 30 days. |
| **Credentials** | Name, service type, owner project, age. Needs an owner or admin key. |
| **Variables** | Names only. Skipped on plans without variables. |
| **Security report** | n8n's audit: risk label and finding titles with counts. |

2. Click **Verify now**. The health check reads the two secrets, checks the address is https, and reads one workflow.

If a check fails:

* **401.** The key is wrong, expired, revoked or belongs to another instance.
* **403 or 404 on one collector.** The key lacks that scope, is not an owner or admin key, or the plan does not include the feature. That collector skips; the others still run.

***

## Data Tables

Each table has a `run_at` column and keeps only the newest run.

| Table | Source | Key Columns |
| - | - | - |
| `n8n_users` | `GET /users?includeRole=true` | user\_id, email, global\_role, is\_pending, mfa\_enabled, created\_at\_src |
| `n8n_projects` | `GET /projects` | project\_id, project\_name, project\_type, creator\_id |
| `n8n_project_members` | `GET /projects/{id}/users` | project\_id, email, project\_role |
| `n8n_workflows` | `GET /workflows` | workflow\_id, workflow\_name, is\_active, is\_archived, tags, owner\_project\_id |
| `n8n_workflow_runs` | `GET /executions` (counts only) | workflow\_id, last\_run\_at, last\_run\_status, runs\_7d, failed\_7d, runs\_30d, failed\_30d |
| `n8n_credentials` | `GET /credentials` | credential\_id, credential\_name, credential\_type, owner\_project\_id, shared\_project\_count |
| `n8n_variables` | `GET /variables` | variable\_id, variable\_key, project\_id |
| `n8n_security_report` | `POST /audit` | report\_name, risk\_label, section\_title, finding\_count |

***

## Things worth knowing

**Run counts cover 30 days.** Configview pages through the executions list for the last 30 days without ever asking for execution data, and keeps only counts per workflow. A workflow with no run in 30 days has no row in `n8n_workflow_runs`. On a very busy instance the scan stops after 100,000 executions and `window_truncated` is set to 1.

**Credentials are metadata.** n8n's credential list never includes secrets, and Configview reads only the id, name, service type, owning project, sharing count and dates. How n8n labels the owner inside a credential's sharing list is not spelled out in the reference, so confirm the owner project on your first run.

**Variable values are never read.** n8n returns each variable's value in the list; Configview ignores it.

**Security report.** Configview asks n8n to generate its audit and stores only each report's risk label, the finding title and the number of places and pending node updates. Workflow names, node names and credential names that n8n lists in the report are discarded.

**Not covered yet.** Tags as their own list, source control settings and per-user activity are not collected.

**Rate limit.** n8n publishes no numeric limit for the public API; it answers HTTP 429 with `Retry-After`. Configview paces itself at 120 requests a minute and waits as long as n8n asks. Pages hold up to 250 items.

## What isn't collected

* Workflow definitions: nodes, connections, settings, static and pinned data
* Execution data, inputs, outputs and logs
* Credential secrets and any credential configuration
* Variable values
* Webhook paths or URLs


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.