n8n API

核心用法

n8n-api 技能提供对 n8n 公开 REST API 的完整封装，允许用户通过 API 密钥认证方式，远程执行原本需要在 UI 中完成的操作。核心能力覆盖六大模块：

1. 工作流管理：列出、创建、更新、激活/停用工作流，获取详细配置
2. 执行监控：查询执行历史、筛选成功/失败状态、获取执行详情与日志
3. 触发执行：通过 Webhook 触发生产环境或测试环境的工作流
4. 故障排查：重试失败执行、分析失败节点参数与错误信息
5. 健康检查：统计活跃工作流数量、24小时内失败率，生成运维摘要
6. 元数据管理：标签、凭证、项目等辅助资源的查询操作

使用方式

配置 N8N_API_BASE_URL 和 N8N_API_KEY 环境变量后，通过标准 HTTP 请求（curl 示例已提供）调用端点。支持自托管实例与 n8n Cloud 两种部署模式。

显著优点

• 权威原生：直接调用 n8n 官方公开 API，非第三方封装，功能与 UI 保持同步
• 运维自动化：可将工作流部署、监控、告警纳入 CI/CD 或定时任务体系
• 故障恢复：支持执行重试与批量失败分析，降低人工介入成本
• 双模式兼容：同时适配本地自托管与云端托管场景

潜在局限

• 付费门槛：API 访问在免费试用期间不可用，需升级付费计划
• 无沙箱环境：Playground 仅自托管可用，且操作真实数据，测试需谨慎
• 执行记录保留：历史执行数据受实例保留策略限制，可能被自动清理
• Webhook 独立认证：Webhook 端点不使用 API Key，需单独管理 URL 安全

适合人群

• 平台运维工程师：需要批量管理多工作流、监控执行健康的 DevOps 团队
• 自动化开发者：将 n8n 集成到更大自动化架构中的后端工程师
• 工作流管理员：负责故障排查、版本发布与权限治理的技术负责人

常规风险

| 风险类型 | 说明 | 缓解建议 |

|---------|------|---------|

| 密钥泄露 | API Key 拥有工作流完全控制权 | 使用环境变量或密钥管理服务，避免硬编码 |

| 误操作生产 | API 直接操作真实工作流状态 | 配置前验证 `N8N_API_BASE_URL`，区分生产/测试实例 |

| 数据暴露 | 执行详情可能包含敏感业务数据 | 限制 API Key 权限范围，启用最小权限原则 |

| 执行重试风险 | 重试失败执行可能产生副作用（如重复通知） | 重试前确认工作流幂等性设计 |

核心用法

n8n-api 是一个纯 Markdown 格式的技能文档，旨在作为指导手册，帮助用户通过 n8n 的公共 REST API 来程序化地驱动 n8n 实例。它覆盖了工作流管理、执行记录监控、Webhook 触发等核心 UI 操作的 API 实现。用户可以通过参考文档中提供的 curl 命令示例，轻松上手，实现工作流的列表查询、详情获取、激活/停用、执行记录检索与重试，以及实例健康状态的快速检查。

显著优点

• 极致安全：该技能为纯文档，零可执行代码、零依赖、零外部 API 调用，完全不存在供应链攻击或数据外泄风险。
• 功能聚焦：内容精准聚焦于 n8n API 最常用、最实用的操作，如健康检查和失败排障流程，能快速解决实际问题。
• 学习成本低：以清晰的 curl 命令为核心，配合环境变量配置指南，使得开发者和运维人员可以即学即用，无缝集成到现有脚本或工具链中。
• 实用性高：提供的“健康检查摘要”和“调试失败运行”等常用流程脚本，可以直接复制使用，极大提升了自动化运维效率。

潜在缺点或局限性

• 完全依赖外部环境：技能本身不提供任何自动化代码，所有功能实现均依赖用户在其本地环境或脚本中执行文档内的命令。其有效性完全取决于用户是否拥有可访问的 n8n 实例和有效的 API 密钥。
• 信息静态化：作为一个静态文档，它无法自动获取最新的 API 变更或提供交互式的调试体验。用户需要手动处理 API 返回的错误。
• 来源不可验证：该技能由匿名维护者提交，来源可信度为 T3，尽管内容本身安全，但缺少官方背书和持续的维护承诺。

适合的目标群体

• DevOps 工程师与 SRE：需要将 n8n 工作流监控集成到现有运维体系（如 CI/CD 管道、监控告警系统）中的专业人员。
• 自动化开发者：需要为其应用或脚本添加程序化控制和编排 n8n 工作流能力的开发者。
• n8n 平台管理员：负责管理大型或复杂 n8n 实例，需要进行批量操作或自动化状态检查的团队。

使用风险

• 安全风险：文档本身无风险，但用户若在不受信任的环境中硬编码 API 密钥或通过不安全的网络传输请求，则可能导致 n8n 实例被未授权访问。风险根源在于用户对 API 密钥的管理，而非技能本身。
• 运行风险：直接执行文档中的 curl 命令，尤其是在activate等变更操作上，如果参数错误，可能导致工作流意外发布或配置错误，影响线上业务。
• 兼容性风险：随着 n8n 版本迭代，部分 API 端点或参数可能过时，而静态文档可能无法及时更新，导致操作失败。