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
25 changes: 25 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ edit the command's Short, Long, Example or flag usage and run `make docs`.
| [`n8n credential test`](n8n_credential_test.md) | Test stored credential data |
| [`n8n credential transfer`](n8n_credential_transfer.md) | Transfer a credential to another project |
| [`n8n credential update`](n8n_credential_update.md) | Update a credential from secret JSON |
| [`n8n credential-policy attachment get`](n8n_credential-policy_attachment_get.md) | Get credential type policy attachments |
| [`n8n credential-policy attachment set`](n8n_credential-policy_attachment_set.md) | Replace credential type policy attachments |
| [`n8n credential-policy attachment`](n8n_credential-policy_attachment.md) | Manage attached credential type policy documents |
| [`n8n credential-policy document create`](n8n_credential-policy_document_create.md) | Create credential type policy documents |
| [`n8n credential-policy document delete`](n8n_credential-policy_document_delete.md) | Delete credential type policy documents |
| [`n8n credential-policy document get`](n8n_credential-policy_document_get.md) | Get credential type policy documents |
| [`n8n credential-policy document list`](n8n_credential-policy_document_list.md) | List credential type policy documents |
| [`n8n credential-policy document set`](n8n_credential-policy_document_set.md) | Replace credential type policy documents |
| [`n8n credential-policy document`](n8n_credential-policy_document.md) | Manage reusable credential type policy documents |
| [`n8n credential-policy instance get`](n8n_credential-policy_instance_get.md) | Get the instance credential type policy |
| [`n8n credential-policy instance set`](n8n_credential-policy_instance_set.md) | Replace the instance credential type policy |
| [`n8n credential-policy instance`](n8n_credential-policy_instance.md) | Manage instance credential type policies |
| [`n8n credential-policy project get`](n8n_credential-policy_project_get.md) | Get the project credential type policy |
| [`n8n credential-policy project set`](n8n_credential-policy_project_set.md) | Replace the project credential type policy |
| [`n8n credential-policy project`](n8n_credential-policy_project.md) | Manage project credential type policies |
| [`n8n credential-policy`](n8n_credential-policy.md) | Manage credential type availability policies |
| [`n8n credential`](n8n_credential.md) | Manage node credentials without exposing secrets |
| [`n8n data-table column create`](n8n_data-table_column_create.md) | Add a column to a data table |
| [`n8n data-table column delete`](n8n_data-table_column_delete.md) | Permanently delete a column and its data |
Expand Down Expand Up @@ -97,6 +113,15 @@ edit the command's Short, Long, Example or flag usage and run `make docs`.
| [`n8n log-stream event-type list`](n8n_log-stream_event-type_list.md) | List event names available for streaming |
| [`n8n log-stream event-type`](n8n_log-stream_event-type.md) | Inspect streamable event types |
| [`n8n log-stream`](n8n_log-stream.md) | Manage licensed log streaming destinations |
| [`n8n node-policy attachment get`](n8n_node-policy_attachment_get.md) | Get node type policy attachments |
| [`n8n node-policy attachment set`](n8n_node-policy_attachment_set.md) | Replace node type policy attachments |
| [`n8n node-policy attachment`](n8n_node-policy_attachment.md) | Manage attached node type policy documents |
| [`n8n node-policy document create`](n8n_node-policy_document_create.md) | Create node type policy documents |
| [`n8n node-policy document delete`](n8n_node-policy_document_delete.md) | Delete node type policy documents |
| [`n8n node-policy document get`](n8n_node-policy_document_get.md) | Get node type policy documents |
| [`n8n node-policy document list`](n8n_node-policy_document_list.md) | List node type policy documents |
| [`n8n node-policy document set`](n8n_node-policy_document_set.md) | Replace node type policy documents |
| [`n8n node-policy document`](n8n_node-policy_document.md) | Manage reusable node type policy documents |
| [`n8n node-policy instance get`](n8n_node-policy_instance_get.md) | Get the instance node type policy |
| [`n8n node-policy instance set`](n8n_node-policy_instance_set.md) | Fully replace the instance node type policy |
| [`n8n node-policy instance`](n8n_node-policy_instance.md) | Manage the instance node type policy |
Expand Down
1 change: 1 addition & 0 deletions docs/n8n.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ n8n [flags]
* [n8n completion](n8n_completion.md) - Generate a shell completion script
* [n8n config](n8n_config.md) - Inspect and edit stored CLI configuration
* [n8n credential](n8n_credential.md) - Manage node credentials without exposing secrets
* [n8n credential-policy](n8n_credential-policy.md) - Manage credential type availability policies
* [n8n data-table](n8n_data-table.md) - Manage data tables, their rows and their columns
* [n8n discover](n8n_discover.md) - List the API capabilities available to the current credential
* [n8n evaluation](n8n_evaluation.md) - Run and inspect workflow evaluations
Expand Down
33 changes: 33 additions & 0 deletions docs/n8n_credential-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## n8n credential-policy

Manage credential type availability policies

### Synopsis

Manage instance and project credential type policies. Start with 'instance get', then inspect 'attachment get' before editing scopes with shared documents. GET returns composed rules; scope set replaces only the scope's own document and default. Documents are reusable rule lists. Floor attachments run first, then priority ascending within each group. The first matching rule wins. Preview API: breaking changes may occur. Requires credentialTypePolicy:manage and the licensed type-availability-policies module. Use --output json for the full response; text prints a summary.

```
n8n credential-policy [flags]
```

### Examples

```
n8n credential-policy instance get
n8n credential-policy document list
```

### Options

```
-h, --help help for credential-policy
```

### SEE ALSO

* [n8n](n8n.md) - Command-line client for the n8n API
* [n8n credential-policy attachment](n8n_credential-policy_attachment.md) - Manage attached credential type policy documents
* [n8n credential-policy document](n8n_credential-policy_document.md) - Manage reusable credential type policy documents
* [n8n credential-policy instance](n8n_credential-policy_instance.md) - Manage instance credential type policies
* [n8n credential-policy project](n8n_credential-policy_project.md) - Manage project credential type policies

31 changes: 31 additions & 0 deletions docs/n8n_credential-policy_attachment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## n8n credential-policy attachment

Manage attached credential type policy documents

### Synopsis

Inspect or replace a scope's complete attachment list. Start with 'get'. Obtain SCOPE_ID from 'instance get' or 'project get PROJECT_ID' -> scopeId; it is null until that scope is first written with set. Requires instance-level access even for project scopes. Floor attachments evaluate first, then priority ascending within each group. Preview API: breaking changes may occur. Requires credentialTypePolicy:manage and the licensed type-availability-policies module. Use --output json for the full response; text prints a summary.

```
n8n credential-policy attachment [flags]
```

### Examples

```
n8n credential-policy instance get --output json
n8n credential-policy attachment get SCOPE_ID
```

### Options

```
-h, --help help for attachment
```

### SEE ALSO

* [n8n credential-policy](n8n_credential-policy.md) - Manage credential type availability policies
* [n8n credential-policy attachment get](n8n_credential-policy_attachment_get.md) - Get credential type policy attachments
* [n8n credential-policy attachment set](n8n_credential-policy_attachment_set.md) - Replace credential type policy attachments

31 changes: 31 additions & 0 deletions docs/n8n_credential-policy_attachment_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## n8n credential-policy attachment get

Get credential type policy attachments

### Synopsis

Read a scope's attachments and version in evaluation order: floor first, then priority ascending within each group. Get SCOPE_ID from 'instance get' or 'project get PROJECT_ID' -> scopeId; it is null until the scope is first written. Requires instance-level access even for project scopes. Use the returned version with 'attachment set'. Preview API: breaking changes may occur. Requires credentialTypePolicy:manage and the licensed type-availability-policies module. Use --output json for the full response; text prints a summary.

```
n8n credential-policy attachment get <scope-id> [flags]
```

### Examples

```
n8n credential-policy attachment get SCOPE_ID
```

### 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 get
--output string output format: text or json (default: text; JSON contains the full response) (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

* [n8n credential-policy attachment](n8n_credential-policy_attachment.md) - Manage attached credential type policy documents

34 changes: 34 additions & 0 deletions docs/n8n_credential-policy_attachment_set.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## n8n credential-policy attachment set

Replace credential type policy attachments

### Synopsis

Fully replace all attachments using JSON {"attachments":[{"policyId":"POLICY_ID","priority":0,"isFloor":false}],"version":1}. Each policyId and (isFloor,priority) pair must be unique. Use [] to detach every document. Get SCOPE_ID from 'instance get' or 'project get PROJECT_ID' -> scopeId; null means write that scope first. Requires instance-level access even for projects. Delegate documents cannot attach to projects. Use the last-read scope version: stale writes return 409. Replacing attachments changes policy evaluation and bumps the scope version. Interactive runs confirm; non-interactive runs and --input - require --yes. Returns attachments and the new version; read-only rules in GET input are dropped with a stderr diagnostic. Preview API: breaking changes may occur. Requires credentialTypePolicy:manage and the licensed type-availability-policies module. Use --output json for the full response; text prints a summary.

```
n8n credential-policy attachment set <scope-id> [flags]
```

### Examples

```
n8n credential-policy attachment set SCOPE_ID --input policy.json
n8n credential-policy attachment set SCOPE_ID --input - --yes < policy.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 set
--input string JSON file path, or - for stdin (required; maximum 1 MiB; stdin requires --yes)
--output string output format: text or json (default: text; JSON contains the full response) (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 mutation without prompting (default: false; required for non-interactive replacement/deletion and --input -)
```

### SEE ALSO

* [n8n credential-policy attachment](n8n_credential-policy_attachment.md) - Manage attached credential type policy documents

34 changes: 34 additions & 0 deletions docs/n8n_credential-policy_document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## n8n credential-policy document

Manage reusable credential type policy documents

### Synopsis

Manage reusable rule lists. Start with 'list', then 'get' before 'set'. Create produces an unattached document; attach it with 'attachment set'. Updating a document changes every attached scope and bumps their versions. A document containing delegate cannot be attached to a project scope. Preview API: breaking changes may occur. Requires credentialTypePolicy:manage and the licensed type-availability-policies module. Use --output json for the full response; text prints a summary.

```
n8n credential-policy document [flags]
```

### Examples

```
n8n credential-policy document list
n8n credential-policy document get POLICY_ID --output json
```

### Options

```
-h, --help help for document
```

### SEE ALSO

* [n8n credential-policy](n8n_credential-policy.md) - Manage credential type availability policies
* [n8n credential-policy document create](n8n_credential-policy_document_create.md) - Create credential type policy documents
* [n8n credential-policy document delete](n8n_credential-policy_document_delete.md) - Delete credential type policy documents
* [n8n credential-policy document get](n8n_credential-policy_document_get.md) - Get credential type policy documents
* [n8n credential-policy document list](n8n_credential-policy_document_list.md) - List credential type policy documents
* [n8n credential-policy document set](n8n_credential-policy_document_set.md) - Replace credential type policy documents

34 changes: 34 additions & 0 deletions docs/n8n_credential-policy_document_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## n8n credential-policy document create

Create credential type policy documents

### Synopsis

Create an unattached reusable document from JSON {"rules":[]}. Rules are required; each rule has a unique id, action allow|deny|delegate, and selector {kind,value}. Creation returns {policy,warnings}; warnings do not fail the write. Attach the returned policy.id using 'attachment set'. --input - requires --yes. Selectors accept name or package. Credential policies also accept extends, matching the named type and every type extending it. Preview API: breaking changes may occur. Requires credentialTypePolicy:manage and the licensed type-availability-policies module. Use --output json for the full response; text prints a summary.

```
n8n credential-policy document create [flags]
```

### Examples

```
n8n credential-policy document create --input policy.json
n8n credential-policy document create --input - --yes < policy.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
--input string JSON file path, or - for stdin (required; maximum 1 MiB; stdin requires --yes)
--output string output format: text or json (default: text; JSON contains the full response) (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 mutation without prompting (default: false; required for non-interactive replacement/deletion and --input -)
```

### SEE ALSO

* [n8n credential-policy document](n8n_credential-policy_document.md) - Manage reusable credential type policy documents

33 changes: 33 additions & 0 deletions docs/n8n_credential-policy_document_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## n8n credential-policy document delete

Delete credential type policy documents

### Synopsis

Permanently delete an unattached document found with 'document list'. Attached documents return 409: inspect 'attachment get' and use 'attachment set' to detach first. Interactive runs confirm; non-interactive runs require --yes. Success returns the deleted ID; deletion cannot be undone. Preview API: breaking changes may occur. Requires credentialTypePolicy:manage and the licensed type-availability-policies module. Use --output json for the full response; text prints a summary.

```
n8n credential-policy document delete <policy-id> [flags]
```

### Examples

```
n8n credential-policy document delete POLICY_ID
n8n credential-policy document delete POLICY_ID --yes
```

### 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 delete
--output string output format: text or json (default: text; JSON contains the full response) (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 mutation without prompting (default: false; required for non-interactive replacement/deletion and --input -)
```

### SEE ALSO

* [n8n credential-policy document](n8n_credential-policy_document.md) - Manage reusable credential type policy documents

31 changes: 31 additions & 0 deletions docs/n8n_credential-policy_document_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## n8n credential-policy document get

Get credential type policy documents

### Synopsis

Read a reusable document's ID, kind, ordered rules, version, updater and timestamps. Find POLICY_ID with 'document list'. Edit rules and use the last-read version with 'document set'; read-only fields are dropped with a stderr diagnostic. Preview API: breaking changes may occur. Requires credentialTypePolicy:manage and the licensed type-availability-policies module. Use --output json for the full response; text prints a summary.

```
n8n credential-policy document get <policy-id> [flags]
```

### Examples

```
n8n credential-policy document get POLICY_ID
```

### 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 get
--output string output format: text or json (default: text; JSON contains the full response) (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

* [n8n credential-policy document](n8n_credential-policy_document.md) - Manage reusable credential type policy documents

39 changes: 39 additions & 0 deletions docs/n8n_credential-policy_document_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## n8n credential-policy document list

List credential type policy documents

### Synopsis

List reusable documents in cursor pages (default 100, maximum 250). Use --cursor for another page, or --all to collect up to 10,000 documents. Start here to find POLICY_ID for get, set, and delete. 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
without reaching the end. nextCursor then resumes the walk when the limit fell
between pages; it stays empty when the limit fell inside a page, because
resuming from the next page would skip items: narrow the filters or page
explicitly with --limit and --cursor instead. Preview API: breaking changes may occur. Requires credentialTypePolicy:manage and the licensed type-availability-policies module. Use --output json for the full response; text prints a summary.

```
n8n credential-policy document list [flags]
```

### Examples

```
n8n credential-policy document list
```

### Options

```
--all follow cursor pages up to 10,000 documents (default: false)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
--cursor string cursor returned by a previous list (default: first page)
-h, --help help for list
--limit int documents per page, 1 to 250 (default: 100) (default 100)
--output string output format: text or json (default: text; JSON contains the full response) (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

* [n8n credential-policy document](n8n_credential-policy_document.md) - Manage reusable credential type policy documents

Loading
Loading