API 认证#

n8n 使用 API 密钥（API keys）来认证 API 调用。

功能可用性 n8n API 在免费试用期间不可用。请升级账户以使用此功能。

API 作用域（Scopes）#

企业版实例 的用户可以通过作用域（scopes）限制密钥可访问的资源和操作。API 密钥作用域允许你为密钥指定其用途所需的精确访问级别。

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

创建一个 API 密钥#

1. 登录到 n8n。
2. 进入 设置（Settings） > n8n API。
3. 选择 创建 API 密钥（Create an API key）。
4. 设置密钥的 标签（Label） 并选择 过期时间（Expiration）。
5. 如果使用的是企业版计划，请选择该密钥的 作用域（Scopes）。
6. 复制 我的 API 密钥（My API Key），并在调用 API 时使用该密钥进行身份验证。

使用你的密钥调用 API#

在 API 请求头（header）中以 X-N8N-API-KEY 字段发送你的 API 密钥。 例如，假设你想获取所有启用状态的工作流（workflows）。你的 curl 请求将如下所示：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

| ```

对于自托管的 n8n 实例

curl 'GET'
'<N8N_HOST>:<N8N_PORT>/<N8N_PATH>/api/v/workflows?active=true'
-H 'accept: application/json'
-H 'X-N8N-API-KEY: '

对于 n8n Cloud

curl 'GET'
'/api/v/workflows?active=true'
-H 'accept: application/json'
-H 'X-N8N-API-KEY: '

---|---

## 删除一个 API 密钥#
  1. 登录到 n8n。
  2. 进入 **设置（Settings）** > **n8n API**。
  3. 点击你想要删除的密钥旁边的 **删除（Delete）**。
  4. 确认删除操作，选择 **永久删除（Delete Forever）**。

与文档交流
本页面是否对你有帮助？!赞有帮助  !踩没有帮助
感谢你的反馈！
提交

 上一页  n8n 公共 REST API 文档与指南   下一页  分页 

由  Material for MkDocs Insiders  提供支持