n8n

https://docs.n8n.io
Admin
n8n is a fair-code licensed workflow automation tool that connects any app with an API to any other...
Tokens:1,467,817
Snippets:12,465
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start n8n after installation

Source: https://docs.n8n.io/deploy/host-n8n/install-options/install-with-npm

Start n8n after installation. Both 'n8n' and 'n8n start' commands are shown.

```bash
n8n
# or
n8n start
```

--------------------------------

### Install community package response

Source: https://docs.n8n.io/connect/n8n-api/community-package

Example response for the install community package endpoint. Returns the installed package details.

```json
{
  "packageName": "text",
  "installedVersion": "text",
  "authorName": "text",
  "authorEmail": "text",
  "installedNodes": [
    {
      "name": "text",
      "type": "text",
      "latestVersion": 1
    }
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "updateAvailable": "text",
  "failedLoading": true
}
```

--------------------------------

### Successful one-line setup output

Source: https://docs.n8n.io/deploy/host-n8n/install-options/one-line-setup

Example output from a successful one-line setup run. Shows the checks performed, files created, and the n8n URL. Includes commands to stop, upgrade, and uninstall n8n, with a warning that the uninstall command deletes all n8n data.

```bash
$ curl -fsSL https://get.n8n.io | sh

✓ Docker found (24.0.6)
✓ Docker Compose found (v2.24.0)
✓ Created ./n8n/compose.yml
✓ Created ./n8n/searxng-settings.yml
✓ Created ./n8n/.env (unique secrets generated)
Pulling images and starting (this can take a few minutes on first run)...
✓ Started n8n 2.32.0 and sandbox services

n8n is running at: http://localhost:5678
Data stored in:    ./n8n (Docker volume: n8n-data)
Config files:      ./n8n/compose.yml, ./n8n/.env

To stop:      docker compose -f ./n8n/compose.yml down
To upgrade:   curl -fsSL https://get.n8n.io | sh -s -- --upgrade
To uninstall: docker compose -f ./n8n/compose.yml down -v   # -v DELETES all n8n data
              rm -rf ./n8n
```

--------------------------------

### Install libvirt dependencies for CRC setup

Source: https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-openshift-local-crc

Installs required packages to fix 'libvirt not found' error during `crc setup`. After running these commands, re-run `crc setup`.

```bash
sudo apt install -y qemu-kvm libvirt-daemon-system libvirt-clients
sudo systemctl start libvirtd
```

--------------------------------

### Download and run n8n one-line setup script

Source: https://docs.n8n.io/deploy/host-n8n/install-options/one-line-setup

Downloads the n8n one-line setup script, lets you review it, then runs it. Use this if you prefer not to run a script directly from the internet.

```bash
curl -fsSL https://get.n8n.io -o get-n8n.sh
less get-n8n.sh   # review it
sh get-n8n.sh
```

--------------------------------

### Clone the starter repository

Source: https://docs.n8n.io/connect/create-nodes/build-your-node/tutorial-build-a-declarative-style-node

Clones the starter repository and navigates into the project directory. Replace the placeholder URL with your own repository.

```shell
git clone https://github.com/<your-organization>/<your-repo-name>.git n8n-nodes-nasa-pics
cd n8n-nodes-nasa-pics
```

--------------------------------

### Get execution tags - response example

Source: https://docs.n8n.io/connect/n8n-api/executions

Example JSON response for a successful get tags operation, showing an array of tag objects with id, name, and timestamps.

```json
[
  {
    "id": "2tUt1wbLX592XDdX",
    "name": "Production",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]
```

--------------------------------

### Run CRC setup

Source: https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-openshift-local-crc

Configures KVM networking, checks system requirements, and downloads the CRC bundle (~2.5 GB). Takes several minutes.

```bash
crc setup
```

--------------------------------

### GET /settings/otel response

Source: https://docs.n8n.io/connect/n8n-api/settings-otel

Example response body for the GET request, showing all fields of the OpenTelemetry configuration.

```json
{
  "enabled": true,
  "exporterProtocol": "http/protobuf",
  "exporterEndpoint": "http://localhost:4318",
  "exporterTracingPath": "/v1/traces",
  "exporterServiceName": "n8n",
  "exporterHeaders": "authorization=Bearer my-token,x-tenant-id=acme",
  "tracesSampleRate": 1,
  "startupConnectivityTimeoutMs": 2000,
  "includeNodeSpans": true,
  "injectOutbound": true,
  "productionExecutionsOnly": true
}
```

--------------------------------

### startOf() example with month unit

Source: https://docs.n8n.io/build/work-with-data/transform-data/expression-reference/datetime

Rounds a DateTime down to the start of the month. The example shows the DateTime '2024-03-20T18:49' becoming '2024-03-01T00:00'.

```javascript
// dt = "2024-03-20T18:49".toDateTime()
dt.startOf('month') //=> 2024-03-01T00:00
```

--------------------------------

### Example Caddyfile with automate.example.com

Source: https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-digital-ocean

Example Caddy configuration using automate.example.com as the domain.

```caddyfile
automate.example.com {
    reverse_proxy n8n:5678 {
      flush_interval -1
    }
}
```

--------------------------------

### Start CRC cluster output

Source: https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-openshift-local-crc

Example output after starting the cluster, showing the web console URL and login credentials.

```text
Started the OpenShift cluster.

The server is accessible via web console at:
  https://console-openshift-console.apps-crc.testing

Log in as administrator:
  Username: kubeadmin
  Password: <generated-password>

Log in as user:
  Username: developer
  Password: developer
```

--------------------------------

### Start and enable libvirtd service

Source: https://docs.n8n.io/deploy/host-n8n/install-options/use-a-cloud-provider/deploy-to-openshift-local-crc

Starts the libvirt service and enables it to start automatically on boot.

```bash
sudo systemctl start libvirtd
sudo systemctl enable libvirtd
```

--------------------------------

### Full example with static and JWKS sources

Source: https://docs.n8n.io/deploy/host-n8n/deploy-as-an-oem-integration/set-up-token-exchange

This example shows a complete configuration array that mixes both static and JWKS key sources. It includes a static key and a JWKS endpoint.

```json
[
	{
		"type": "static",
		"kid": "my-static-key-1",
		"algorithms": ["RS256"],
		"key": "-----BEGIN PUBLIC KEY-----\nMIIBIjAN...your-key-here...\n-----END PUBLIC KEY-----",
		"issuer": "https://your-backend.example.com",
		"expectedAudience": "https://your-n8n.example.com",
		"allowedRoles": ["global:member"]
	},
	{
		"type": "jwks",
		"url": "https://idp.example.com/.well-known/jwks.json",
		"issuer": "https://idp.example.com",
		"expectedAudience": "https://your-n8n.example.com"
	}
]
```

--------------------------------

### $jmespath() examples with data object and queries

Source: https://docs.n8n.io/build/work-with-data/transform-data/expression-reference/root

Examples of using $jmespath() to query a nested data object. The first block defines a data object and shows three JMESPath queries: getting all names, getting names and ages of people over 20, and getting the name of the first person under 20. The second block defines a reservations object and shows a query to get names of guests requiring a double room.

```javascript
data = {
  "people": [
    {
      "age": 20,
      "other": "foo",
      "name": "Bob"
    },
    {
      "age": 25,
      "other": "bar",
      "name": "Fred"
    },
    {
      "age": 30,
      "other": "baz",
      "name": "George"
    }
  ]
}

// Get all names, in an array
{{ $jmespath(data, '[*].name') }} //=> ["Bob", "Fred", "George"]

// Get the names and ages of everyone under 20
$jmespath(data, '[?age > `20`].[name, age]') //=> [ ["Fred",25], ["George",30] ]

// Get the name of the first person under 20
$jmespath($json.people, '[?age > `20`].name | [0]') //=> Fred
```

```javascript
data = {
    "reservations": [
      {
        "id": 1,
        "guests": [
          {
            "name": "Nathan",
            "requirements": {
              "room": "double",
              "meal": "vegetarian"
            }
          },
          {
            "name": "Meg",
            "requirements": {
              "room": "single"
            }
          }
        ]
      },
      {
        "id": 2,
        "guests": [
          {
            "name": "Lex",
            "requirements": {
              "room": "double"
            }
          }
        ]
      }
    ]
  }

// Get the names of all the guests in each reservation that require a double room
$jmespath(data, 'reservations[].guests[?requirements.room==`double`].name')
```

--------------------------------

### toSpliced() example

Source: https://docs.n8n.io/build/work-with-data/transform-data/expression-reference/array

Adds and/or removes array elements at a given position. The example deletes 2 elements starting at index 1.

```javascript
// Delete 2 elements starting at index 1
// arr = ["don't", "make", "me", "do", "this"]
arr.toSpliced(1, 2) // ["don't", "do", "this"]
```

--------------------------------

### Clone the starter repository

Source: https://docs.n8n.io/connect/create-nodes/build-your-node/tutorial-build-a-programmatic-style-node

Clone your generated repository and navigate into the directory. Replace <your-organization> and <your-repo-name> with your actual GitHub details.

```shell
git clone https://github.com/<your-organization>/<your-repo-name>.git n8n-nodes-friendgrid
cd n8n-nodes-friendgrid
```
Tokens:
Raw