API 认证
n8n 使用 API 密钥来验证 API 呼叫。
提示
功能可用性
n8n API 在免费试用期间不可用。请升级才能使用此功能。
创建 API 密钥
- 登录n8n。
- 转至 设置 > n8n API。
- 选择创建 API 密钥。
- 选择一个标签并为密钥设置过期时间。
- 如果您的实例是 n8n 2.14.0 或更新版本,或者您在更早版本上使用企业计划,请选择范围来提供密钥。有关可用范围的完整列表,请参阅 API 范围。
- 复制 我的 API 密钥 并使用此密钥来验证您的呼叫。
使用您的密钥呼叫 API
在 API 调用中将 API 密钥作为名为 X-N8N-API-KEY 的标头发送。
例如,假设您想要获取所有活动的工作流程。您的卷曲请求将如下所示:
# For a self-hosted n8n instance <a href="#for-a-self-hosted-n8n-instance" id="for-a-self-hosted-n8n-instance"></a>
curl -X 'GET' \
'<N8N_HOST>:<N8N_PORT>/<N8N_PATH>/api/v<version-number>/workflows?active=true' \
-H 'accept: application/json' \
-H 'X-N8N-API-KEY: <your-api-key>'
# For n8n Cloud <a href="#for-n8n-cloud" id="for-n8n-cloud"></a>
curl -X 'GET' \
'<your-cloud-instance>/api/v<version-number>/workflows?active=true' \
-H 'accept: application/json' \
-H 'X-N8N-API-KEY: <your-api-key>'
节点配置
要从工作流程中调用 n8n API,请使用 n8n节点。创建凭据时,请填写以下字段:
- API 密钥:粘贴您在 创建 API 密钥 中创建的密钥。
- 基础 URL:采用以下格式之一输入实例的 API 根:
- 云:
https://<name>.app.n8n.cloud/api/v1,其中 <name> 是您的云子域。
- 自托管:
https://<your-instance-url>/api/v1。
有关可用的操作和参数,请参阅 n8n节点 文档。
删除 API 密钥
- 登录n8n。
- 转至 设置 > n8n API。
- 选择要删除的密钥旁边的 删除。
- 选择 永久删除 确认删除。
API 范围
您可以通过范围限制 API 密钥可以访问哪些资源和操作。从 n8n 2.14.0 开始,所有计划都可以使用范围;在更早的版本上,需要企业计划才能使用范围。选择密钥预期用途所需的最小范围。
在 2.14.0 之前的版本上,非企业 API 密钥可以完全访问帐户的所有资源和功能。
提示
API 关键范围与项目角色范围
API 密钥范围控制 API 密钥在实例级别可以执行的操作。它们与用于在项目内定义自定义角色的项目角色范围不同。有关项目角色范围,请参阅 自定义项目角色。
下表列出了创建范围 API 密钥时可用的范围(按资源分组)。
社区包范围
| 范围 |
描述 |
communityPackage:install |
在实例上安装社区节点包。 |
communityPackage:list |
列出已安装的社区节点包。 |
communityPackage:uninstall |
卸载社区节点包。 |
communityPackage:update |
更新已安装的社区节点包。 |
凭证范围
| 范围 |
描述 |
credential:create |
创建凭据。 |
credential:read |
检索凭证及其数据架构。 |
credential:list |
列出凭据。 |
credential:update |
更新凭证。 |
credential:delete |
删除凭证。 |
credential:move |
将凭证转移到另一个项目。 |
数据表范围
| 范围 |
描述 |
dataTable:create |
创建数据表。 |
dataTable:read |
检索数据表。 |
dataTable:list |
列出数据表。 |
dataTable:update |
更新数据表的元数据。 |
dataTable:delete |
删除数据表。 |
数据表列范围
| 范围 |
描述 |
dataTableColumn:create |
向数据表添加列。 |
dataTableColumn:read |
检索数据表列。 |
dataTableColumn:update |
更新数据表列。 |
dataTableColumn:delete |
删除数据表列。 |
数据表行范围
| 范围 |
描述 |
dataTableRow:create |
将行插入数据表中。 |
dataTableRow:read |
从数据表中读取行。 |
dataTableRow:update |
更新数据表中的现有行。 |
dataTableRow:delete |
从数据表中删除行。 |
dataTableRow:upsert |
更新数据表中的现有行,如果没有行符合过滤条件,则插入新行。 |
执行范围
| 范围 |
描述 |
execution:read |
检索执行及其详细信息。 |
execution:list |
列出执行。 |
execution:retry |
重试失败的执行。 |
execution:stop |
停止正在运行的执行。 |
execution:delete |
删除执行。 |
执行标记范围
| 范围 |
描述 |
executionTags:list |
读取分配给执行的注释标签。 |
executionTags:update |
更新分配给执行的注释标签。 |
文件夹范围
| 范围 |
描述 |
folder:create |
在项目中创建文件夹。 |
folder:read |
检索文件夹。 |
folder:list |
列出项目中的文件夹。 |
folder:update |
更新文件夹。 |
folder:delete |
删除文件夹。 |
洞察范围
| 范围 |
描述 |
insights:read |
读取实例洞察数据,包括执行计数、故障率、节省的时间和平均运行时间。 |
项目范围
| 范围 |
描述 |
project:create |
创建项目。 |
project:list |
列出项目。 |
project:update |
更新项目。 |
project:delete |
删除项目。 |
安全审计范围
| 范围 |
描述 |
securityAudit:generate |
生成实例的安全审计报告。 |
源控制范围
| 范围 |
描述 |
sourceControl:pull |
将更改从连接的源代码控制存储库拉取到实例中。 |
标签范围
| 范围 |
描述 |
tag:create |
在全局标签注册表中创建标签。 |
tag:read |
检索标签。 |
tag:list |
列出标签。 |
tag:update |
更新标签。 |
tag:delete |
删除标签。 |
用户范围
| 范围 |
描述 |
user:create |
在实例上邀请或创建用户。 |
user:read |
检索用户。 |
user:list |
列出用户。 |
user:changeRole |
更改用户的全局(实例级)角色。 |
user:enforceMfa |
保留范围。没有 /api/v1/ 端点会使用它,因此在公共 API 密钥上选择此范围不会产生面向公众的效果。 |
user:delete |
从实例中删除用户。 |
变量范围
| 范围 |
描述 |
variable:create |
创建实例变量。 |
variable:list |
列出实例变量。 |
variable:update |
更新实例变量。 |
variable:delete |
删除实例变量。 |
工作流程范围
| 范围 |
描述 |
workflow:create |
创建工作流程。 |
workflow:read |
检索工作流程及其详细信息。 |
workflow:list |
列出工作流程。 |
workflow:update |
更新工作流程。 |
workflow:delete |
删除、存档或取消存档工作流程。 |
workflow:move |
将工作流程转移到另一个项目。 |
workflow:activate |
激活或停用工作流程。在公共 API(/workflows/{id}/activate 和 /workflows/{id}/deactivate)中也称为“发布/取消发布”。 |
工作流标签范围
| 范围 |
描述 |
workflowTags:list |
读取分配给工作流程的标签。 |
workflowTags:update |
更新分配给工作流程的标签。 |
相关资源