API认证#

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

功能可用性

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

API 作用域#

企业版实例的用户可以通过作用域限制密钥可访问的资源与操作。API密钥作用域允许您精确指定密钥所需访问权限级别，以满足其预期用途。

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

创建API密钥#

登录n8n。
前往设置 > n8n API。
选择创建API密钥。
选择一个标签并为密钥设置过期时间。
如果是企业版计划，请选择要授予密钥的作用域。
复制我的API密钥并使用该密钥验证您的调用。

使用您的密钥调用API#

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

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

# For a self-hosted n8n instance
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
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。
选择要删除的密钥旁边的删除。
通过选择永久删除来确认删除操作。