Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions docs/n8n_data-table_row_insert.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ selects what comes back: count, the inserted ids, or the full rows. The whole
batch is one request, so the API accepts or rejects it as a whole. Requires
dataTableRow:create.

--idempotency-key KEY makes a retry after a timeout or lost response safe:
the same request with the same key returns the first result instead of
running again (auto generates a key and prints it on stderr).

```
n8n data-table row insert <table-id> [flags]
```
Expand All @@ -24,20 +28,21 @@ n8n data-table row insert <table-id> [flags]
```
n8n data-table row insert TABLE_ID --set email=a@example.com --set age=30
n8n data-table row insert TABLE_ID --set email=b@example.com --return all --output json
n8n data-table row insert TABLE_ID --input rows.json --return id
n8n data-table row insert TABLE_ID --input rows.json --return id --idempotency-key auto
printf '%s\n' '[{"email":"c@example.com"}]' | n8n data-table row insert TABLE_ID --input -
```

### Options

```
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
-h, --help help for insert
--input string row JSON array or object, from a file path or - for stdin (cannot combine with --set; maximum 1 MiB)
--output string output format: text or json (JSON preserves the count, ids and rows the API sent) (default "text")
--return string what the API returns: count, id or all (default: the server default of count)
--set stringArray column value as COLUMN=VALUE for one row, repeatable (cannot combine with --input)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
-h, --help help for insert
--idempotency-key string retry key sent as the Idempotency-Key header: 1 to 128 visible ASCII characters, or auto for a random UUID printed on stderr; rerun the same command with the same key to get the first result instead of a second run (default: none, no idempotency)
--input string row JSON array or object, from a file path or - for stdin (cannot combine with --set; maximum 1 MiB)
--output string output format: text or json (JSON preserves the count, ids and rows the API sent) (default "text")
--return string what the API returns: count, id or all (default: the server default of count)
--set stringArray column value as COLUMN=VALUE for one row, repeatable (cannot combine with --input)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
```

### SEE ALSO
Expand Down
27 changes: 16 additions & 11 deletions docs/n8n_data-table_row_upsert.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ The inserted row is built from the values given, not from the filter, so
include the matched column in --set when the new row should carry it. Use
--dry-run to see what would happen first. Requires dataTableRow:upsert.

--idempotency-key KEY makes a retry after a timeout or lost response safe:
the same request with the same key returns the first result instead of
running again (auto generates a key and prints it on stderr).

```
n8n data-table row upsert <table-id> [flags]
```
Expand All @@ -27,17 +31,18 @@ n8n data-table row upsert <table-id> [flags]
### Options

```
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
--dry-run ask the server to report the change without persisting it (implies --return-data)
--filter string whole filter object as JSON, e.g. '{"type":"and","filters":[{"columnName":"status","condition":"eq","value":"active"}]}' (cannot combine with --where)
-h, --help help for upsert
--input string column values as a JSON object, from a file path or - for stdin (cannot combine with --set; maximum 1 MiB)
--match string how several --where expressions combine: and or or (default "and")
--output string output format: text or json (JSON contains the acknowledgement and any returned rows) (default "text")
--return-data ask the API for the affected rows instead of a bare acknowledgement
--set stringArray column value to write as COLUMN=VALUE, repeatable (cannot combine with --input)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--where stringArray row condition as COLUMN=VALUE or COLUMN=CONDITION=VALUE, repeatable, conditions: eq, neq, like, ilike, gt, gte, lt, lte (required unless --filter is given)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
--dry-run ask the server to report the change without persisting it (implies --return-data)
--filter string whole filter object as JSON, e.g. '{"type":"and","filters":[{"columnName":"status","condition":"eq","value":"active"}]}' (cannot combine with --where)
-h, --help help for upsert
--idempotency-key string retry key sent as the Idempotency-Key header: 1 to 128 visible ASCII characters, or auto for a random UUID printed on stderr; rerun the same command with the same key to get the first result instead of a second run (default: none, no idempotency)
--input string column values as a JSON object, from a file path or - for stdin (cannot combine with --set; maximum 1 MiB)
--match string how several --where expressions combine: and or or (default "and")
--output string output format: text or json (JSON contains the acknowledgement and any returned rows) (default "text")
--return-data ask the API for the affected rows instead of a bare acknowledgement
--set stringArray column value to write as COLUMN=VALUE, repeatable (cannot combine with --input)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--where stringArray row condition as COLUMN=VALUE or COLUMN=CONDITION=VALUE, repeatable, conditions: eq, neq, like, ilike, gt, gte, lt, lte (required unless --filter is given)
```

### SEE ALSO
Expand Down
17 changes: 11 additions & 6 deletions docs/n8n_execution_retry.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ The original execution is retained and the response identifies the new run. A
run that cannot be retried returns a conflict. This starts workflow work and may
repeat its external side effects. Requires execution:retry.

--idempotency-key KEY makes a retry after a timeout or lost response safe:
the same request with the same key returns the first result instead of
running again (auto generates a key and prints it on stderr).

```
n8n execution retry <execution-id> [flags]
```
Expand All @@ -22,17 +26,18 @@ n8n execution retry <execution-id> [flags]
```
n8n execution retry EXECUTION_ID
n8n execution retry EXECUTION_ID --latest-workflow
n8n execution retry EXECUTION_ID --output json
n8n execution retry EXECUTION_ID --idempotency-key auto --output json
```

### Options

```
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
-h, --help help for retry
--latest-workflow run the workflow currently saved instead of the definition stored with the original execution (default: stored definition)
--output string output format: text or json (JSON is the newly started execution) (default "text")
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
-h, --help help for retry
--idempotency-key string retry key sent as the Idempotency-Key header: 1 to 128 visible ASCII characters, or auto for a random UUID printed on stderr; rerun the same command with the same key to get the first result instead of a second run (default: none, no idempotency)
--latest-workflow run the workflow currently saved instead of the definition stored with the original execution (default: stored definition)
--output string output format: text or json (JSON is the newly started execution) (default "text")
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
```

### SEE ALSO
Expand Down
25 changes: 15 additions & 10 deletions docs/n8n_execution_stop-many.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ workflows globally by accident; the literal workflow ID 'all' is rejected, use
or canceled run may later be retried. Interactive runs ask for confirmation and
non-interactive runs require --yes. Requires execution:stop.

--idempotency-key KEY makes a retry after a timeout or lost response safe:
the same request with the same key returns the first result instead of
running again (auto generates a key and prints it on stderr).

```
n8n execution stop-many [flags]
```
Expand All @@ -29,16 +33,17 @@ n8n execution stop-many [flags]
### Options

```
--all stop matching executions across every accessible workflow (cannot combine with --workflow-id)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
-h, --help help for stop-many
--output string output format: text or json (JSON contains the number stopped) (default "text")
--started-after string only executions started after this RFC3339 timestamp, e.g. 2026-09-17T00:00:00Z (default: no lower bound)
--started-before string only executions started before this RFC3339 timestamp, e.g. 2026-09-18T00:00:00Z (default: no upper bound)
--status stringArray status to stop: queued, running, or waiting; repeatable (at least one required)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--workflow-id string only executions of this workflow, from 'n8n workflow list' (required unless --all)
--yes confirm stopping every match without prompting (required when stdin is not interactive)
--all stop matching executions across every accessible workflow (cannot combine with --workflow-id)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
-h, --help help for stop-many
--idempotency-key string retry key sent as the Idempotency-Key header: 1 to 128 visible ASCII characters, or auto for a random UUID printed on stderr; rerun the same command with the same key to get the first result instead of a second run (default: none, no idempotency)
--output string output format: text or json (JSON contains the number stopped) (default "text")
--started-after string only executions started after this RFC3339 timestamp, e.g. 2026-09-17T00:00:00Z (default: no lower bound)
--started-before string only executions started before this RFC3339 timestamp, e.g. 2026-09-18T00:00:00Z (default: no upper bound)
--status stringArray status to stop: queued, running, or waiting; repeatable (at least one required)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--workflow-id string only executions of this workflow, from 'n8n workflow list' (required unless --all)
--yes confirm stopping every match without prompting (required when stdin is not interactive)
```

### SEE ALSO
Expand Down
15 changes: 10 additions & 5 deletions docs/n8n_execution_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ execution. A run already finished or otherwise not stoppable returns a conflict.
Interactive runs ask for confirmation and non-interactive runs require --yes.
The workflow definition is untouched. Requires execution:stop.

--idempotency-key KEY makes a retry after a timeout or lost response safe:
the same request with the same key returns the first result instead of
running again (auto generates a key and prints it on stderr).

```
n8n execution stop <execution-id> [flags]
```
Expand All @@ -26,11 +30,12 @@ n8n execution stop <execution-id> [flags]
### Options

```
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
-h, --help help for stop
--output string output format: text or json (JSON is the resulting stop state) (default "text")
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--yes confirm canceling the execution without prompting (required when stdin is not interactive)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
-h, --help help for stop
--idempotency-key string retry key sent as the Idempotency-Key header: 1 to 128 visible ASCII characters, or auto for a random UUID printed on stderr; rerun the same command with the same key to get the first result instead of a second run (default: none, no idempotency)
--output string output format: text or json (JSON is the resulting stop state) (default "text")
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--yes confirm canceling the execution without prompting (required when stdin is not interactive)
```

### SEE ALSO
Expand Down
6 changes: 6 additions & 0 deletions docs/n8n_package_import-selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ deleting or when an update changes a workflow's archive state, and the
licensed Packages feature. Output is the same import result as
'n8n package import'.

--idempotency-key KEY makes a retry after a timeout or lost response safe:
the same request with the same key returns the first result instead of
running again (auto generates a key and prints it on stderr). A retry must send
the same archive under the same file name with the same flags.

```
n8n package import-selection [flags]
```
Expand All @@ -52,6 +57,7 @@ n8n package import-selection [flags]
--delete-workflow-id stringArray destination workflow ID to remove from the target project, repeatable; needs workflow:delete and must not match a --workflow-id (default: none)
--file string project package archive (.n8np) to import from: a file path, or - for stdin (required; stdin requires --yes)
-h, --help help for import-selection
--idempotency-key string retry key sent as the Idempotency-Key header: 1 to 128 visible ASCII characters, or auto for a random UUID printed on stderr; rerun the same command with the same key to get the first result instead of a second run (default: none, no idempotency)
--output string output format: text or json (JSON is the full import result) (default "text")
--overwrite-deletion-policy string how --delete-workflow-id removes workflows: archive (recoverable) or hard-delete (also drops executions permanently; prefer archive); needs --delete-workflow-id (default: server default archive)
--project-id string source project ID as it appears in the package; also the target project ID, created if missing (required)
Expand Down
6 changes: 6 additions & 0 deletions docs/n8n_package_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ credential, variable, tag, data-table, folder, and delete scopes, and
the Packages, Variables, and Folders features where the contents
require them.

--idempotency-key KEY makes a retry after a timeout or lost response safe:
the same request with the same key returns the first result instead of
running again (auto generates a key and prints it on stderr). A retry must send
the same archive under the same file name with the same flags.

```
n8n package import [flags]
```
Expand All @@ -56,6 +61,7 @@ n8n package import [flags]
--folder-conflict-policy string existing folder handling: merge, fail, or overwrite; empty follows --project-conflict-policy on project packages, merge otherwise (default: follow)
--folder-id string folder within the target project, from 'n8n folder list PROJECT_ID' (default: the project root)
-h, --help help for import
--idempotency-key string retry key sent as the Idempotency-Key header: 1 to 128 visible ASCII characters, or auto for a random UUID printed on stderr; rerun the same command with the same key to get the first result instead of a second run (default: none, no idempotency)
--missing-node-type-mode string unknown node type handling: fail rejects before anything is written, import-anyway imports without publishing those workflows (default: server default fail)
--output string output format: text or json (JSON is the full import result) (default "text")
--overwrite-deletion-policy string how folder overwrite removes missing workflows: archive (recoverable) or hard-delete (also drops executions; prefer archive) (default: server default archive)
Expand Down
5 changes: 5 additions & 0 deletions docs/n8n_promotion_apply-continue.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ mutually exclusive. Interactive runs ask for confirmation; non-interactive
runs and stdin input require --yes. JSON returns the server result; text
shows counts and the commit after success.

--idempotency-key KEY makes a retry after a timeout or lost response safe:
the same request with the same key returns the first result instead of
running again (auto generates a key and prints it on stderr).

```
n8n promotion apply-continue <connection-id> [flags]
```
Expand All @@ -49,6 +53,7 @@ n8n promotion apply-continue <connection-id> [flags]
--expected-config-id string reviewed config ID, 1 to 36 characters (default: omitted; requires expected branch and commit)
--expected-from string changes or blocked-apply JSON file, or - for stdin (default: explicit expected-source flags; stdin requires --yes)
-h, --help help for apply-continue
--idempotency-key string retry key sent as the Idempotency-Key header: 1 to 128 visible ASCII characters, or auto for a random UUID printed on stderr; rerun the same command with the same key to get the first result instead of a second run (default: none, no idempotency)
--input string request JSON file path or - for stdin, maximum 1 MiB (default: use document flags; stdin requires --yes)
--output string output format: text or json (default: text; JSON is the full server result) (default "text")
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
Expand Down
Loading
Loading