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

凭据

凭据相关操作

列出凭据

获取实例中的所有凭据，仅实例所有者和管理员可用。不包含凭据数据（秘密信息）。

GET/credentials

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 data.[]name string 是 data.[]type string 是 data.[]createdAt string 是 data.[]updatedAt string 是 data.[]shared array 是
nextCursor	string	是

下载完整 OpenAPI 定义（JSON）

创建凭据

创建可供指定类型节点使用的凭据。

POST/credentials

请求参数

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

请求体

application/json

字段	类型	必填	说明
id	string	否	未被使用的凭据 ID，由 1–16 个字母、数字、下划线或连字符组成。提供的 ID 将原样保留。省略时自动生成 ID。
name	string	是
description	string	否	纯文本，最多 512 个字符。空白值保存为 null。禁用凭据说明时忽略。
type	string	是
data	object	是	凭据数据。字段也接受 n8n 表达式，即以 "=" 开头的字符串。
isResolvable	boolean	否	此凭据是否包含可解析字段
createdAt	string	否	只读。
updatedAt	string	否	只读。
projectId	string	否	创建凭据的项目，默认为用户的个人项目。

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
type	string	是
isManaged	boolean	是
isGlobal	boolean	是
isResolvable	boolean	是
resolvableAllowFallback	boolean	是
resolverId	string	是
createdAt	string	是
updatedAt	string	是
description	string	否	仅在启用凭据说明时返回。

下载完整 OpenAPI 定义（JSON）

按 ID 获取凭据

按 ID 获取凭据，不包含凭据数据（秘密信息）。

GET/credentials/{credentialId}

请求参数

参数	位置	类型	必填	说明
credentialId	path	string	是	凭据的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
type	string	是
isManaged	boolean	是
isGlobal	boolean	是
isResolvable	boolean	是
resolvableAllowFallback	boolean	是
resolverId	string	是
createdAt	string	是
updatedAt	string	是
description	string	否	仅在启用凭据说明时返回。

下载完整 OpenAPI 定义（JSON）

按 ID 删除凭据

从实例中删除凭据。你必须是此凭据的所有者。

DELETE/credentials/{credentialId}

请求参数

参数	位置	类型	必填	说明
credentialId	path	string	是	凭据的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
type	string	是
isManaged	boolean	是
isGlobal	boolean	是
isResolvable	boolean	是
resolvableAllowFallback	boolean	是
resolverId	string	是
createdAt	string	是
updatedAt	string	是
description	string	否	仅在启用凭据说明时返回。
usageScope	string	是	可选值：project, instance

下载完整 OpenAPI 定义（JSON）

按 ID 更新凭据

更新现有凭据。你必须是此凭据的所有者。

PATCH/credentials/{credentialId}

请求参数

参数	位置	类型	必填	说明
credentialId	path	string	是	凭据的 ID。

请求体

application/json

字段	类型	必填	说明
name	string	否	凭据名称
description	string	否	纯文本，最多 512 个字符。发送 null 或空白值可清除；省略则保留已存储的值。禁用凭据说明时忽略。
type	string	否	凭据类型。更改类型时也必须提供 data。
data	object	否	凭据数据。更改凭据类型时必填。字段也接受 n8n 表达式，即以 "=" 开头的字符串。
isGlobal	boolean	否	此凭据是否全局可用
isResolvable	boolean	否	此凭据是否包含可解析字段
isPartialData	boolean	否	为 true 时，取消现有凭据数据的遮蔽，并将其与提供的数据合并；为 false 时，替换整个 data 对象。 默认值：false

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
type	string	是
isManaged	boolean	是
isGlobal	boolean	是
isResolvable	boolean	是
resolvableAllowFallback	boolean	是
resolverId	string	是
createdAt	string	是
updatedAt	string	是
description	string	否	仅在启用凭据说明时返回。

下载完整 OpenAPI 定义（JSON）

将凭据转移到另一个项目。

将凭据转移到另一个项目。

PUT/credentials/{credentialId}/transfer

请求参数

参数	位置	类型	必填	说明
credentialId	path	string	是	凭据的 ID。

请求体

application/json

字段	类型	必填	说明
destinationProjectId	string	是	接收此凭据的项目 ID。

响应

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

下载完整 OpenAPI 定义（JSON）

按 ID 测试凭据

按 ID 使用已存储的凭据数据测试凭据。

POST/credentials/{credentialId}/test

请求参数

参数	位置	类型	必填	说明
credentialId	path	string	是	凭据的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
status	string	是	可选值：OK, Error
message	string	是

下载完整 OpenAPI 定义（JSON）

GET /credentials/schema/{credentialTypeName}（获取凭据数据架构）

显示凭据数据架构

GET/credentials/schema/{credentialTypeName}

请求参数

参数	位置	类型	必填	说明
credentialTypeName	path	string	是	要获取其架构的凭据类型名称

响应

状态码	说明
200	操作成功。
401	未授权
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
additionalProperties	boolean	是	可选值：False
type	string	是	可选值：object
properties	object	是	凭据类型各字段的 JSON Schema 片段，以字段名为键。
required	array	是	请求必须包含的字段名称。具有默认值的字段不在此列表中。
allOf	array	否

下载完整 OpenAPI 定义（JSON）

列出凭据依赖项

列出使用此凭据的工作流和智能体。

GET/credentials/{credentialId}/dependencies

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
credentialId	path	string	是	凭据的 ID。

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]type string 是 与所请求资源的关系。credential、dataTable、subWorkflow、errorWorkflow：所请求的工作流使用此依赖项。parentWorkflow：此工作流使用所请求的资源。errorWorkflowParent：此工作流将所请求的工作流用作错误工作流。agent：此智能体使用所请求的资源。 可选值：agent, credential, dataTable, errorWorkflow, errorWorkflowParent, parentWorkflow, subWorkflow data.[]id string 是 data.[]name string 是 data.[]projectId string 否 依赖项所属项目（已知时返回）。
nextCursor	string	是
inaccessibleCount	integer	是	你无权访问的依赖项数量；这些依赖项不会列出。

下载完整 OpenAPI 定义（JSON）