n8n 自动化

通过 REST API 控制 n8n 工作流自动化平台。

设置

设置以下环境变量（或存储在 .n8n-api-config 文件中）：

bash
export N8NAPIURL=https://your-instance.app.n8n.cloud/api/v1 # 或 http://localhost:5678/api/v1
export N8NAPIKEY=your-api-key-here

生成 API 密钥：n8n 设置 → n8n API → 创建 API 密钥。

快速参考

所有调用均使用 X-N8N-API-KEY 标头进行身份验证。

列出工作流

bash curl -s -H X-N8N-API-KEY: $N8NAPIKEY $N8NAPIURL/workflows | jq .data[] | {id, name, active}

获取工作流详情

bash curl -s -H X-N8N-API-KEY: $N8NAPIKEY $N8NAPIURL/workflows/{id}

激活/停用工作流

bash

激活

curl -s -X PATCH -H X-N8N-API-KEY: $N8NAPIKEY \ -H Content-Type: application/json \ -d {active: true} $N8NAPIURL/workflows/{id}

停用

curl -s -X PATCH -H X-N8N-API-KEY: $N8NAPIKEY \ -H Content-Type: application/json \ -d {active: false} $N8NAPIURL/workflows/{id}

触发工作流（通过 webhook）

bash

生产环境 webhook

curl -s -X POST $N8NAPIURL/../webhook/{webhook-path} \ -H Content-Type: application/json \ -d {key: value}

测试环境 webhook

curl -s -X POST $N8NAPIURL/../webhook-test/{webhook-path} \ -H Content-Type: application/json \ -d {key: value}

列出执行记录

bash

所有近期执行记录

curl -s -H X-N8N-API-KEY: $N8NAPIKEY $N8NAPIURL/executions?limit=10 | jq .data[] | {id, workflowId, status, startedAt}

仅失败执行记录

curl -s -H X-N8N-API-KEY: $N8NAPIKEY $N8NAPIURL/executions?status=error&limit=5

特定工作流的执行记录

curl -s -H X-N8N-API-KEY: $N8NAPIKEY $N8NAPIURL/executions?workflowId={id}&limit=10

获取执行详情

bash curl -s -H X-N8N-API-KEY: $N8NAPIKEY $N8NAPIURL/executions/{id}

创建工作流（从 JSON）

bash curl -s -X POST -H X-N8N-API-KEY: $N8NAPIKEY \ -H Content-Type: application/json \ -d @workflow.json $N8NAPIURL/workflows

删除工作流

bash curl -s -X DELETE -H X-N8N-API-KEY: $N8NAPIKEY $N8NAPIURL/workflows/{id}

常见模式

健康检查（定期运行）

列出活跃工作流，检查近期执行记录中的错误，报告状态： bash

统计活跃工作流数量

ACTIVE=$(curl -s -H X-N8N-API-KEY: $N8NAPIKEY $N8NAPIURL/workflows?active=true | jq .data | length)

统计失败执行记录数量（最近24小时）

FAILED=$(curl -s -H X-N8N-API-KEY: $N8NAPIKEY $N8NAPIURL/executions?status=error&limit=100 | jq [.data[] | select(.startedAt > (now - 86400 | todate))] | length)

echo 活跃工作流：$ACTIVE | 失败（24小时）：$FAILED

调试失败执行

1. 1. 列出失败执行记录 → 获取执行 ID
2. 获取执行详情 → 找到失败节点
3. 检查节点参数和输入数据
4. 根据错误信息建议修复方案

工作流摘要

解析工作流 JSON 以生成摘要：触发器类型、节点数量、连接的应用、调度计划。

API 端点参考

完整端点文档请参见 references/api-endpoints.md。

提示

• - 非企业版计划中 API 密钥拥有完全访问权限
• 速率限制因计划而异（云端）或无限制（自托管）
• Webhook URL 与 API URL 分开（无需身份验证标头）
• 使用 ?active=true 或 ?active=false 过滤工作流列表
• 执行数据可能根据 n8n 保留设置进行清理