Skip to content
Merged
7 changes: 5 additions & 2 deletions docs/n8n_credential_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@ Create a credential from secret JSON
### Synopsis

Create a credential from one JSON document. Required fields are name, type and
data; optional fields are projectId and isResolvable. Because data contains
secrets, JSON is accepted only through --file or piped --stdin, never argv.
data; optional fields are projectId, isResolvable, description (plain text, at
most 512 characters; ignored when the instance has descriptions disabled) and
id (1 to 16 letters, digits, underscores or hyphens, kept exactly; omit it to
have one generated). Because data contains secrets, JSON is accepted only
through --file or piped --stdin, never argv.

The request body is excluded from debug logs. Output contains metadata only.
Requires credential:create; project creation can have additional role restrictions.
Expand Down
10 changes: 6 additions & 4 deletions docs/n8n_credential_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ Update a credential from secret JSON

### Synopsis

Update an owned credential from one JSON document. Accepted fields are name, type,
data, isGlobal, isResolvable and isPartialData. Set isPartialData=true to merge
provided data with stored data; false replaces the full data object. Changing type
requires data. Managed credentials cannot be edited.
Update an owned credential from one JSON document. Accepted fields are name,
description, type, data, isGlobal, isResolvable and isPartialData. Set
isPartialData=true to merge provided data with stored data; false replaces the
full data object. Changing type requires data. description is at most 512
characters; null or "" clears it and omitting it keeps it. Managed credentials
cannot be edited.

Secret JSON is accepted only through --file or piped --stdin and is excluded from
debug logs and output. Requires credential:update and ownership.
Expand Down
4 changes: 3 additions & 1 deletion docs/n8n_data-table_column_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Add a column to a data table
### Synopsis

Add one column to an existing data table. The type is one of string, number, boolean, date
and cannot be changed afterwards; recreate the column to change it.
and cannot be changed afterwards; recreate the column to change it. The name
starts with a letter, uses only letters, digits and underscores, and is at
most 63 characters.

Without --index the column is appended after the existing ones. Existing rows
get an empty value in the new column. A name already used in the table comes
Expand Down
14 changes: 8 additions & 6 deletions docs/n8n_data-table_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ Create a data table
Create one data table with its columns. Pass --column once per column as
NAME:TYPE; at least one is required, and the column order is the order given.

Documented types are string, number, boolean, date and json, though instances
can reject json with a 400. Without --project-id the table is created in the
caller's personal project. The system columns id, createdAt and updatedAt are
added by n8n; do not declare them. Add more columns later with
'n8n data-table column create'. Requires dataTable:create.
Types are string, number, boolean, date; the API no longer accepts json,
so store JSON in a string column. Column names start with a letter, use only
letters, digits and underscores, and are at most 63 characters. Without
--project-id the table is created in the caller's personal project. The
system columns id, createdAt and updatedAt are added by n8n; do not declare
them. Add more columns later with 'n8n data-table column create'. Requires
dataTable:create.

```
n8n data-table create <name> [flags]
Expand All @@ -28,7 +30,7 @@ n8n data-table create <name> [flags]
### Options

```
--column stringArray column as NAME:TYPE, repeatable and required, e.g. email:string (types: string, number, boolean, date, json)
--column stringArray column as NAME:TYPE, repeatable and required, e.g. email:string (types: string, number, boolean, date)
--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 create
--output string output format: text or json (JSON is the created table) (default "text")
Expand Down
8 changes: 4 additions & 4 deletions docs/n8n_data-table_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ time. Pass a returned cursor to --cursor for the next page, or use --all to
follow every cursor, capped at 10,000 tables.

Use this to find the table ID every other command takes. --name is the only
filter the API documents. --sort-by takes field:asc or field:desc, for example
name:asc or size:desc, where size orders by the reported sizeBytes. Requires
dataTable:list and API-key authentication.
filter the API documents. --sort-by takes name, createdAt, updatedAt or size,
then :asc or :desc, for example name:asc or size:desc, where size orders by
the reported sizeBytes. Requires dataTable:list and API-key authentication.

With --all, JSON output adds a collection object. Its truncated field is true,
and a warning goes to stderr, when the walk stopped at the 10,000-item limit
Expand Down Expand Up @@ -43,7 +43,7 @@ n8n data-table list [flags]
--limit int tables per API page, 1 to 250 (default: server default of 100)
--name string only tables with this name (default: every table)
--output string output format: text or json (JSON is a page object with data and nextCursor, plus collection with --all) (default "text")
--sort-by string sort order as field:asc or field:desc, e.g. name:asc or size:desc (default: the server's order)
--sort-by string sort order, one of name:asc, name:desc, createdAt:asc, createdAt:desc, updatedAt:asc, updatedAt:desc, size:asc, size:desc (default: the server's order)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
```

Expand Down
9 changes: 5 additions & 4 deletions docs/n8n_folder_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Update one folder. This is a partial update: --name renames the folder,
and passing both does both. At least one of them is required; anything left out
stays as it is.

The API has no way to clear a parent, so a folder cannot be moved back to the
project root with this command, and the target folder must be in the same
project. Requires folder:update.
--parent-folder-id 0 moves the folder back to the project root. Otherwise the
target folder must be in the same project. Names are at most 128 characters.
Requires folder:update.

```
n8n folder update <project-id> <folder-id> [flags]
Expand All @@ -22,6 +22,7 @@ n8n folder update <project-id> <folder-id> [flags]
```
n8n folder update PROJECT_ID FOLDER_ID --name "Paid invoices"
n8n folder update PROJECT_ID FOLDER_ID --parent-folder-id OTHER_FOLDER_ID
n8n folder update PROJECT_ID FOLDER_ID --parent-folder-id 0
n8n folder update PROJECT_ID FOLDER_ID --name Archive --parent-folder-id OTHER_FOLDER_ID --output json
```

Expand All @@ -32,7 +33,7 @@ n8n folder update <project-id> <folder-id> [flags]
-h, --help help for update
--name string new folder name (required unless --parent-folder-id is given)
--output string output format: text or json (JSON is the updated folder) (default "text")
--parent-folder-id string move the folder inside this folder (required unless --name is given)
--parent-folder-id string move the folder inside this folder, or 0 for the project root (required unless --name is given)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
```

Expand Down
35 changes: 23 additions & 12 deletions docs/n8n_project_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@ Create a project

### Synopsis

Create one project with the given name. Name is the only writable field; the ID
and type are assigned by the instance.

The API contract declares no response body for this call, so an instance that
returns none is reported as created without an ID; run 'n8n project list' to
recover it. Quote names containing spaces. Add members afterwards with
'n8n project user add'. Requires project:create and a licensed instance.
Create one team project with the given name, at most 255 characters. The
instance assigns the ID unless --id picks one (at most 36 characters; an ID
already in use is a 409). --description, --icon and --telemetry-tag set the
optional fields; after creation only the name can be changed, with
'n8n project update'.

The output is the created project, including the caller's role and scopes in
it. Older instances answer with no body; that is reported as created without
an ID, and 'n8n project list' recovers it. Quote names containing spaces. Add
members afterwards with 'n8n project user add'. Requires project:create and a
licensed instance.

```
n8n project create <name> [flags]
Expand All @@ -20,16 +24,23 @@ n8n project create <name> [flags]

```
n8n project create "Billing automation"
n8n project create Staging --output json
n8n project create Marketing --description "Workflows the marketing team owns" --icon emoji:📣
n8n project create Ops --icon icon:server --icon-color "#ff6d5a" --telemetry-tag team=ops
n8n project create Staging --id staging --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 create
--output string output format: text or json (JSON is the project object) (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')
--description string plain-text description, at most 512 characters (default: none)
-h, --help help for create
--icon string icon as emoji:EMOJI or icon:NAME, e.g. emoji:📣 or icon:server (default: none)
--icon-color string icon color, e.g. #ff6d5a; requires --icon (default: the instance's color)
--id string project ID to use, at most 36 characters (default: generated by the instance)
--output string output format: text or json (JSON is the project object) (default "text")
--telemetry-tag stringArray custom telemetry tag as KEY=VALUE, repeatable (default: none)
--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
11 changes: 6 additions & 5 deletions docs/n8n_variable_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ Create a variable

Create one variable with a complete key and value. Omit --project-id for a
global variable, or pass a project ID for project scope. A key must be unique
within that scope; a duplicate fails with a conflict.
within that scope; a duplicate fails with a conflict. Keys start with a letter
or underscore, then use letters, digits and underscores, at most 50 in all.

--value is required, though an explicitly empty value is valid. The submitted
value is sent to n8n but never repeated in CLI diagnostics or acknowledgement
output. Requires variable:create.
--value is required, though an explicitly empty value is valid; it is at most
1000 characters. The submitted value is sent to n8n but never repeated in CLI
diagnostics or acknowledgement output. Requires variable:create.

```
n8n variable create <key> [flags]
Expand All @@ -30,7 +31,7 @@ n8n variable create <key> [flags]
--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 create
--output string output format: text or json (acknowledgement excludes the submitted value) (default "text")
--project-id string project scope ID (default: global scope; on update this replaces current scope)
--project-id string project scope ID, at most 36 characters (default: global scope on create; on update see the command help)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--value string complete variable value; pass an empty string to store an empty value (required, not repeated in diagnostics)
```
Expand Down
15 changes: 9 additions & 6 deletions docs/n8n_variable_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@ Fully replace a variable
### Synopsis

Fully replace one variable by ID. This is a PUT, so --key and --value are both
required even when one is unchanged. Omitting --project-id replaces the current
scope with global scope; pass its project ID to keep or select project scope.
required even when one is unchanged. The API contract makes projectId optional
and nullable here without saying what omitting it does to the current scope,
so pass --project-id to keep or select project scope, and check the result
with 'n8n variable list'.

A key already used in the resulting scope fails with a conflict. An explicitly
empty value is valid. Submitted values never appear in diagnostics or success
acknowledgements. Requires variable:update.
Keys use letters, digits and underscores, at most 50; values are at most 1000
characters. A key already used in the resulting scope fails with a conflict.
An explicitly empty value is valid. Submitted values never appear in
diagnostics or success acknowledgements. Requires variable:update.

```
n8n variable update <variable-id> [flags]
Expand All @@ -31,7 +34,7 @@ n8n variable update <variable-id> [flags]
-h, --help help for update
--key string complete replacement key (required, even when unchanged)
--output string output format: text or json (acknowledgement excludes the submitted value) (default "text")
--project-id string project scope ID (default: global scope; on update this replaces current scope)
--project-id string project scope ID, at most 36 characters (default: global scope on create; on update see the command help)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--value string complete variable value; pass an empty string to store an empty value (required, not repeated in diagnostics)
```
Expand Down
9 changes: 5 additions & 4 deletions docs/n8n_workflow_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ from stdin ('--input -'); without it, --name creates an empty workflow with no
nodes, ready to be edited in the UI or filled in by a later update.

The input may be a document produced by 'n8n workflow get --output json': the
read-only fields (id, versionId, active, timestamps, tags, sharing) are dropped
before sending, because the API answers a read-only field with 400, and the
dropped names are reported on stderr. --name, --project-id and
--parent-folder-id override what the document says.
read-only fields (id, versionId, active, timestamps, tags, sharing, node
timestamps) and settings set to "DEFAULT" are dropped before sending, because
the API answers them with 400, and the dropped names are reported on stderr. A
null settings is sent as {}. --name, --project-id and --parent-folder-id
override what the document says.

A created workflow is never published: publish it with 'n8n workflow publish'.
Requires workflow:create.
Expand Down
36 changes: 20 additions & 16 deletions docs/n8n_workflow_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ every cursor, capped at 10,000 workflows.
Use this to find the workflow ID every other command takes. Narrow the result
set with --active, --name, --tag and --project-id. Each row carries the full
definition, so on a large instance prefer --exclude-pinned-data, which drops
the pinned sample data that dominates the response. Requires workflow:list.
the pinned sample data that dominates the response. --include-parent-folder
adds the containing folder: a FOLDER column in text, parentFolder in JSON
({"id": ...}, or null at the project root). Requires workflow:list.

Script views print rows only, with no header, count or blank lines, so stdout
pipes cleanly; the next cursor and any empty-result hint go to stderr, and an
Expand Down Expand Up @@ -42,27 +44,29 @@ n8n workflow list [flags]
n8n workflow list --active true --limit 50
n8n workflow list --tag production --tag finance
n8n workflow list --project-id PROJECT_ID --exclude-pinned-data
n8n workflow list --project-id PROJECT_ID --include-parent-folder
n8n workflow list --all --output json
```

### Options

```
--active string only published (true) or unpublished (false) workflows (default: both)
--all follow every page instead of one (maximum 10,000 workflows; hitting it warns and sets JSON collection.truncated)
--brief print only ID and name, tab-separated and escaped, with no header (default: full table)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
--cursor string pagination cursor returned by a previous list (default: the first page)
--exclude-pinned-data leave pinned sample data out of the response (default: include it)
-h, --help help for list
--limit int workflows per API page, 1 to 250 (default: server default of 100)
--name string only workflows with exactly this name (default: any name)
--offset int number of workflows to skip before the page (default: start at the first workflow)
--output string output format: text or json (JSON is a page object with data and nextCursor, plus collection with --all) (default "text")
--project-id string only workflows in this project, from 'n8n project list' (default: every project)
--quiet print only workflow IDs, one per line, with no header (default: full table)
--tag stringArray only workflows carrying this tag name, repeatable and combined with AND (default: any tag)
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--active string only published (true) or unpublished (false) workflows (default: both)
--all follow every page instead of one (maximum 10,000 workflows; hitting it warns and sets JSON collection.truncated)
--brief print only ID and name, tab-separated and escaped, with no header (default: full table)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
--cursor string pagination cursor returned by a previous list (default: the first page)
--exclude-pinned-data leave pinned sample data out of the response (default: include it)
-h, --help help for list
--include-parent-folder add each workflow's containing folder, null at the project root (default: omit it)
--limit int workflows per API page, 1 to 250 (default: server default of 100)
--name string only workflows with exactly this name (default: any name)
--offset int number of workflows to skip before the page (default: start at the first workflow)
--output string output format: text or json (JSON is a page object with data and nextCursor, plus collection with --all) (default "text")
--project-id string only workflows in this project, from 'n8n project list' (default: every project)
--quiet print only workflow IDs, one per line, with no header (default: full table)
--tag stringArray only workflows carrying this tag name, repeatable and combined with AND (default: any tag)
--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
Loading
Loading