完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

社区包

社区包相关操作

列出已安装的社区包

获取所有已安装的社区包，包括可更新信息。

GET/community-packages

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问

响应结构：200 · application/json

字段	类型	必填	说明
[]packageName	string	是	npm 包名称
[]installedVersion	string	是	当前安装的版本
[]authorName	string	否	包作者姓名
[]authorEmail	string	否	包作者邮箱
[]installedNodes	array	是	此包包含的节点 展开字段 字段 类型 必填 说明 []installedNodes.[]name string 否 []installedNodes.[]type string 否 []installedNodes.[]latestVersion number 否
[]createdAt	string	是
[]updatedAt	string	是
[]updateAvailable	string	否	可更新到的版本（如有）
[]failedLoading	boolean	否	此包是否加载失败

下载完整 OpenAPI 定义（JSON）

安装社区包

根据 npm 包名称及可选版本安装社区包。

POST/community-packages

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。

请求体

application/json

字段	类型	必填	说明
name	string	是	npm 包名称。不带作用域的名称以 n8n-nodes- 开头；带作用域的名称采用 @[author]/n8n-nodes- 格式。
version	string	否	Semver 版本或 npm dist-tag，例如 latest 或 beta。禁用未验证的包时，只能安装经过 n8n 验证的版本。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
packageName	string	是	npm 包名称
installedVersion	string	是	当前安装的版本
authorName	string	否	包作者姓名
authorEmail	string	否	包作者邮箱
installedNodes	array	是	此包包含的节点 展开字段 字段 类型 必填 说明 installedNodes.[]name string 否 installedNodes.[]type string 否 installedNodes.[]latestVersion number 否
createdAt	string	是
updatedAt	string	是
updateAvailable	string	否	可更新到的版本（如有）
failedLoading	boolean	否	此包是否加载失败
policyRestrictions	object	否	此包中被节点类型策略阻止的节点类型。策略不会导致安装失败。未评估任何策略时不返回此字段，例如未获得节点类型策略功能许可时。nodeTypes 列表为空，表示没有策略阻止此包中的节点类型。 展开字段 字段 类型 必填 说明 policyRestrictions.nodeTypes array 是 此包中被阻止的节点类型，仅列出被阻止的类型。 展开字段 字段 类型 必填 说明 policyRestrictions.nodeTypes.[]type string 是 完整节点类型名称，例如 n8n-nodes-example.exampleNode。 policyRestrictions.nodeTypes.[]blockedOn string 是 instance：默认在实例上阻止；projects：在实例上允许，但在一个或多个项目中阻止。 可选值：instance, projects policyRestrictions.nodeTypes.[]optInAvailable boolean 是 项目能否允许此节点类型。当实例策略阻止此节点类型、但允许项目将其设为允许时，此值为 True。

下载完整 OpenAPI 定义（JSON）

卸载社区包

按名称卸载社区包。

DELETE/community-packages/{name}

请求参数

参数	位置	类型	必填	说明
name	path	string	是	npm 包名称

响应

状态码	说明
204	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

下载完整 OpenAPI 定义（JSON）

更新社区包

将已安装的社区包更新到新版本。

PATCH/community-packages/{name}

请求参数

参数	位置	类型	必填	说明
name	path	string	是	npm 包名称

请求体

application/json

字段	类型	必填	说明
version	string	否	要更新到的 Semver 版本或 npm dist-tag，例如 latest 或 beta。禁用未验证的包时，只能安装经过 n8n 验证的版本。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
packageName	string	是	npm 包名称
installedVersion	string	是	当前安装的版本
authorName	string	否	包作者姓名
authorEmail	string	否	包作者邮箱
installedNodes	array	是	此包包含的节点 展开字段 字段 类型 必填 说明 installedNodes.[]name string 否 installedNodes.[]type string 否 installedNodes.[]latestVersion number 否
createdAt	string	是
updatedAt	string	是
updateAvailable	string	否	可更新到的版本（如有）
failedLoading	boolean	否	此包是否加载失败

下载完整 OpenAPI 定义（JSON）