API 认证#

n8n 使用 API 密钥来验证 API 调用。

功能可用性说明

n8n API 在免费试用期间不可用。请升级以访问此功能。

API 权限范围#

企业版实例的用户可以通过权限范围限制密钥能访问的资源和操作。API 密钥范围允许您根据密钥的预期用途精确指定其所需的访问级别。

非企业版 API 密钥拥有对账户所有资源和功能的完全访问权限。

创建 API 密钥#

登录 n8n
进入设置 > n8n API
选择 创建 API 密钥
为密钥设置一个标签并选择 过期时间
如果是企业版计划，选择要授予密钥的 权限范围
复制 我的 API 密钥 并使用此密钥进行 API 调用认证

使用密钥调用 API#

在 API 调用中通过名为 X-N8N-API-KEY 的请求头发送 API 密钥。

例如，假设您想获取所有活跃的工作流。您的 curl 请求将如下所示：

# 对于自托管的 n8n 实例
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>'


# 对于 n8n 云服务
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>'

删除 API 密钥#

登录 n8n
进入设置 > n8n API
在要删除的密钥旁选择删除
选择 永久删除 确认删除操作