Skip to content

Commit b5eaf23

Browse files
n8n: added API key creds section (#2601)
* n8n docs: add API key section * Remo demo links in url
1 parent 773f424 commit b5eaf23

6 files changed

Lines changed: 21 additions & 9 deletions

File tree

_includes/docs/samples/analytics/n8n-node.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ Before you begin, ensure you have the following:
7676
{% if docsPrefix == "paas/eu/" %}
7777
- **EU ThingsBoard Cloud**: Fully managed cloud service available at [eu.thingsboard.cloud](https://eu.thingsboard.cloud/signup){: target="_blank"}
7878
{% endif %}
79-
- **Authentication credentials**: Valid username and password with appropriate permissions on the ThingsBoard instance
79+
- **Authentication credentials**: API key or username and password (deprecated) with appropriate permissions on the ThingsBoard instance. See [API Keys](/docs/{{docsPrefix}}user-guide/security/api-keys/){: target="_blank"} for details on generating API keys.
8080
- **n8n instance**:
8181
- **Local n8n installation**: Self-hosted n8n on your infrastructure, or
8282
- **Docker-based n8n deployment**: n8n running in Docker containers
83-
- **Cloud n8n**: The ThingsBoard node requires official verification to be listed in the n8n Cloud catalog.
83+
- **Cloud n8n**: The ThingsBoard node is verified and available on [n8n Cloud](https://n8n.io/){: target="_blank"} — no manual installation required.
8484

8585
## Installation
8686

@@ -136,18 +136,30 @@ N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
136136

137137
### Configure Credentials
138138

139-
Connect n8n to your ThingsBoard instance:
139+
Connect n8n to your ThingsBoard instance. There are two authentication options:
140+
141+
#### Option A: API Key
140142

141143
1. Click **+** (top-left) → **Credentials**
142-
2. Search for **ThingsBoard API****Continue**
143-
3. Fill in your ThingsBoard details:
144+
2. Search for **ThingsBoard API Key****Continue**
145+
3. Fill in the required fields:
144146
- **Base URL**: Your instance URL (e.g., {% if docsPrefix == "paas/eu/" %}`https://eu.thingsboard.cloud`{% else %}`https://thingsboard.cloud`{% endif %})
147+
- **Connect using**: API Key
148+
- **API Key**: Generated from your ThingsBoard instance. See [API Keys](/docs/{{docsPrefix}}user-guide/security/api-keys/){: target="_blank"} for details.
149+
4. Click **Save**
150+
151+
#### Option B: Username/Password (Deprecated)
152+
153+
1. Click **+** (top-left) → **Credentials**
154+
2. Search for **ThingsBoard Username/Password****Continue**
155+
3. Fill in the required fields:
156+
- **Base URL**: Your instance URL (e.g., {% if docsPrefix == "paas/eu/" %}`https://eu.thingsboard.cloud`{% else %}`https://thingsboard.cloud`{% endif %})
157+
- **Connect using**: Username/Password
145158
- **Username**: Your email
146159
- **Password**: Your password
147160
4. Click **Save**
148161

149-
These credentials work across all ThingsBoard nodes in your workflows.
150-
162+
The credentials are encrypted and stored securely by n8n. You can reuse the same credentials across multiple ThingsBoard nodes in different workflows.
151163

152164
{% assign n8nGuiInstallation = '
153165
===
@@ -158,10 +170,10 @@ These credentials work across all ThingsBoard nodes in your workflows.
158170
title: Search and select **ThingsBoard API** to connect to and click **Continue**.
159171
===
160172
image: /images/samples/analytics/n8n-node/credentials-configuration-3.png
161-
title: Fill in the required fields:<br>- **Base URL** — your ThingsBoard instance URL (without a trailing slash)<br>- **Username** — your ThingsBoard account username<br>- **Password** — your ThingsBoard account password.<br>Click **Save** to store the credentials.
173+
title: Fill in the **Base URL** — your ThingsBoard instance URL (without a trailing slash), and the **API Key**generated from your ThingsBoard instance. Click **Save** to store the credentials.
162174
===
163175
image: /images/samples/analytics/n8n-node/credentials-configuration-4.png
164-
title: The credentials are encrypted and stored securely by n8n. You can reuse the same credentials across multiple ThingsBoard nodes in different workflows.
176+
title: The credentials are saved and the connection is tested successfully. You can reuse the same credentials across multiple ThingsBoard nodes in different workflows.
165177
'
166178
%}
167179

-2.31 KB
Loading
-5.8 KB
Loading
-1.2 KB
Loading
37.9 KB
Loading
774 Bytes
Loading

0 commit comments

Comments
 (0)