n8n自动化

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

设置

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

export N8N_API_URL="https://your-instance.app.n8n.cloud/api/v1"  # or http://localhost:5678/api/v1
export N8N_API_KEY="your-api-key-here"

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

快速参考

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

列出工作流

curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/workflows" | jq '.data[] | {id, name, active}'

获取工作流详情

curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/workflows/{id}"

激活/停用工作流

# Activate
curl -s -X PATCH -H "X-N8N-API-KEY: $N8N_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"active": true}' "$N8N_API_URL/workflows/{id}"

# Deactivate
curl -s -X PATCH -H "X-N8N-API-KEY: $N8N_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"active": false}' "$N8N_API_URL/workflows/{id}"

触发工作流（通过webhook）

# Production webhook
curl -s -X POST "$N8N_API_URL/../webhook/{webhook-path}" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

# Test webhook
curl -s -X POST "$N8N_API_URL/../webhook-test/{webhook-path}" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

列出执行记录

# All recent executions
curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/executions?limit=10" | jq '.data[] | {id, workflowId, status, startedAt}'

# Failed executions only
curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/executions?status=error&limit=5"

# Executions for specific workflow
curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/executions?workflowId={id}&limit=10"

获取执行详情

curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/executions/{id}"

创建工作流（从JSON）

curl -s -X POST -H "X-N8N-API-KEY: $N8N_API_KEY" \
  -H "Content-Type: application/json" \
  -d @workflow.json "$N8N_API_URL/workflows"

删除工作流

curl -s -X DELETE -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/workflows/{id}"

常见模式

健康检查（定期运行）

列出活跃工作流，检查近期执行记录是否有错误，报告状态：

# Count active workflows
ACTIVE=$(curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/workflows?active=true" | jq '.data | length')

# Count failed executions (last 24h)
FAILED=$(curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_URL/executions?status=error&limit=100" | jq '[.data[] | select(.startedAt > (now - 86400 | todate))] | length')

echo "Active workflows: $ACTIVE | Failed (24h): $FAILED"

调试执行失败

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

工作流摘要

解析工作流JSON以总结：触发器类型、节点数量、连接应用、调度设置

API端点参考

查看references/api-endpoints.md获取完整端点文档

提示

• API密钥在非企业版方案中拥有完全访问权限
• 速率限制因方案而异（云端）或无限制（自托管）
• Webhook URL与API URL相互独立（无需认证标头）
• 使用?active=true或?active=false筛选工作流列表
• 执行数据可能根据n8n保留设置被清理