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

资源晋升（Promotions）

晋升提供方、环境及包操作相关操作

列出晋升提供方

返回提供方的游标分页列表，不包含其公开配置。

GET/promotions/providers

请求参数

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

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 data.[]name string 是 data.[]type string 是 可选值：git, gitlab data.[]authType string 是 可选值：ssh-key, token data.[]createdAt string 是 data.[]updatedAt string 是
nextCursor	string	是

下载完整 OpenAPI 定义（JSON）

创建晋升提供方

创建提供方及其认证材料。Git 主机提供方在保存前会校验经过认证的 API 访问。对于 GitLab，服务使用 n8n 作为 Git 传输用户名，auth.username 可选，任何提供的用户名都会被忽略。普通 Git 令牌认证要求提供 auth.username。SSH 提供方会返回生成的公钥，请将其作为部署密钥添加到远程仓库。

POST/promotions/providers

请求参数

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

请求体

application/json

字段	类型	必填	说明
name	string	是
type	string	是	可选值：git, gitlab
auth	object	是	展开字段 结构 1 字段 类型 必填 说明 auth.authType string 是 可选值：ssh-key auth.keyType string 否 可选值：ed25519, rsa 默认值："ed25519" 结构 2 字段 类型 必填 说明 auth.authType string 是 可选值：token auth.username string 否 普通 Git 令牌认证时必填。对于 GitLab，服务会忽略此字段，使用 n8n 进行 Git 传输。 auth.password string 是
config	object	否	展开字段 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 config.baseUrl string 是

响应

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

响应结构：201 · application/json

字段	类型	必填	说明
provider	object	是	展开字段 字段 类型 必填 说明 provider.id string 是 provider.name string 是 provider.type string 是 可选值：git, gitlab provider.authType string 是 可选值：ssh-key, token provider.config 联合类型 是 展开字段 结构 1 字段 类型 必填 说明 provider.config.schemaVersion number 是 可选值：1 provider.config.publicKey string 是 provider.config.keyType string 是 可选值：ed25519, rsa 结构 2 字段 类型 必填 说明 provider.config.schemaVersion number 是 可选值：1 结构 3 字段 类型 必填 说明 provider.config.schemaVersion number 是 可选值：1 provider.config.baseUrl string 是 provider.createdAt string 是 provider.updatedAt string 是
publicKey	string	是

下载完整 OpenAPI 定义（JSON）

获取晋升提供方

返回提供方及其公开配置，绝不返回秘密信息。

GET/promotions/providers/{promotionProviderId}

请求参数

参数	位置	类型	必填	说明
promotionProviderId	path	string	是	晋升提供方的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。
503	所请求的服务暂时不可用。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
type	string	是	可选值：git, gitlab
authType	string	是	可选值：ssh-key, token
config	联合类型	是	展开字段 结构 1 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 config.publicKey string 是 config.keyType string 是 可选值：ed25519, rsa 结构 2 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 结构 3 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 config.baseUrl string 是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）

更新晋升提供方

重命名提供方；发送 `auth` 时替换其凭据。Git 主机提供方还可更新基础 URL；API 目标变化时，同一请求必须包含 `auth`。凭据和主机设置的变更会在保存前校验。如果本次更新保存前，其他请求已更改凭据或配置，则返回 409，请重新加载提供方后重试。对于 GitLab，服务使用 n8n 作为 Git 传输用户名，auth.username 可选，任何提供的用户名都会被忽略。普通 Git 令牌认证要求提供 auth.username。新凭据会应用到所有使用此提供方的环境。认证方式不能更改。

PUT/promotions/providers/{promotionProviderId}

请求参数

参数	位置	类型	必填	说明
promotionProviderId	path	string	是	晋升提供方的 ID。

请求体

application/json

字段	类型	必填	说明
name	string	否
auth	object	否	展开字段 结构 1 字段 类型 必填 说明 auth.authType string 是 可选值：ssh-key auth.keyType string 否 可选值：ed25519, rsa 结构 2 字段 类型 必填 说明 auth.authType string 是 可选值：token auth.username string 否 普通 Git 令牌认证时必填。对于 GitLab，服务会忽略此字段，使用 n8n 进行 Git 传输。 auth.password string 是
config	object	否	展开字段 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 config.baseUrl string 是

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
name	string	是
type	string	是	可选值：git, gitlab
authType	string	是	可选值：ssh-key, token
config	联合类型	是	展开字段 结构 1 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 config.publicKey string 是 config.keyType string 是 可选值：ed25519, rsa 结构 2 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 结构 3 字段 类型 必填 说明 config.schemaVersion number 是 可选值：1 config.baseUrl string 是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）

删除晋升提供方

被环境使用的提供方不能删除。

DELETE/promotions/providers/{promotionProviderId}

请求参数

参数	位置	类型	必填	说明
promotionProviderId	path	string	是	晋升提供方的 ID。

响应

状态码	说明
204	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
503	所请求的服务暂时不可用。

下载完整 OpenAPI 定义（JSON）

列出晋升提供方的仓库

列出 GitLab 令牌身份至少具有 Developer（开发者）角色的仓库。令牌还需具备晋升所需的 Git 写入作用域。受保护分支可能限制推送。使用 remoteUrl 作为环境的远程地址。搜索按相似度匹配名称和命名空间；不筛选时按仓库 ID 升序排列。limit 是上限，GitLab 每页最多返回 100 项。即使某页少于请求的 limit，也应继续使用 nextCursor。无需预先保存环境。凭据无效时返回错误，而非空列表。响应过大时，请使用更小的 limit 且不带 cursor，重新开始列举。

GET/promotions/providers/{promotionProviderId}/repositories

请求参数

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

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 data.[]name string 是 data.[]fullPath string 是 data.[]remoteUrl string 是 data.[]defaultBranch string 是
nextCursor	string	是

下载完整 OpenAPI 定义（JSON）

列出晋升仓库的分支

列出所选 GitLab 仓库的分支，并标识默认分支。将仓库发现返回的 fullPath，或已保存 GitLab 环境的 repositoryPath，经过 URL 编码后作为 repositoryId 传入。也接受 GitLab 项目 ID，但环境不存储此 ID。支持分支搜索和游标分页。limit 是上限，GitLab 每页最多返回 100 项。即使某页少于请求的 limit，也应继续使用 nextCursor。无需预先保存环境。凭据无效或仓库不可访问时返回错误，而非空列表。响应过大时，请使用更小的 limit 且不带 cursor，重新开始列举。

GET/promotions/providers/{promotionProviderId}/repositories/{repositoryId}/branches

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
promotionProviderId	path	string	是	晋升提供方的 ID。
repositoryId	path	string	是	经过 URL 编码的仓库 fullPath，也接受 GitLab 项目 ID。
search	query	string	否

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]name string 是 data.[]isDefault boolean 是
nextCursor	string	是

下载完整 OpenAPI 定义（JSON）

列出晋升环境

返回环境的游标分页列表。按 `scope` 和 `direction` 筛选实例环境，或按 `providerId` 查看提供方编辑会影响哪些环境。

GET/promotions/environments

请求参数

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

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 结构 1 字段 类型 必填 说明 data.[]id string 是 data.[]name string 是 data.[]scope string 是 可选值：instance, projects data.[]remote object 是 data.[]provider object 是 data.[]createdAt string 是 data.[]updatedAt string 是 data.[]direction string 是 可选值：apply data.[]settings object 是 结构 2 字段 类型 必填 说明 data.[]id string 是 data.[]name string 是 data.[]scope string 是 可选值：instance, projects data.[]remote object 是 data.[]provider object 是 data.[]createdAt string 是 data.[]updatedAt string 是 data.[]direction string 是 可选值：promote data.[]settings object 是
nextCursor	string	是

下载完整 OpenAPI 定义（JSON）

创建晋升环境

在现有提供方上，为某一方向创建环境，设置必须与该方向匹配。GitLab 远程 URL 必须属于已保存的提供方；环境仅存储仓库路径，并根据提供方当前基础 URL 推导 remoteUrl。普通 Git 环境保留完整远程 URL。实例的每个方向可以有一个环境。

POST/promotions/environments

请求参数

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

请求体

application/json

结构 1

字段	类型	必填	说明
name	string	是
scope	string	是	可选值：instance, projects
providerId	string	是
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是
direction	string	是	可选值：apply
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.branchName string 是

结构 2

字段	类型	必填	说明
name	string	是
scope	string	是	可选值：instance, projects
providerId	string	是
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是
direction	string	是	可选值：promote
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.baseBranchName string 是 settings.createBranchOnPromotion boolean 是

响应

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

响应结构：201 · application/json

结构 1

字段	类型	必填	说明
id	string	是
name	string	是
scope	string	是	可选值：instance, projects
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是 remote.repositoryPath string 否 Git 主机远程地址所存储的仓库路径。将其用作 repositoryId 列出分支前，请进行 URL 编码。请求不接受此字段。
provider	object	是	展开字段 字段 类型 必填 说明 provider.id string 是 provider.name string 是 provider.type string 是 可选值：git, gitlab provider.authType string 是 可选值：ssh-key, token provider.createdAt string 是 provider.updatedAt string 是
createdAt	string	是
updatedAt	string	是
direction	string	是	可选值：apply
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.branchName string 是
checkout	object	是	展开字段 字段 类型 必填 说明 checkout.hasCheckout boolean 是 checkout.matchesEnvironment boolean 是

结构 2

字段	类型	必填	说明
id	string	是
name	string	是
scope	string	是	可选值：instance, projects
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是 remote.repositoryPath string 否 Git 主机远程地址所存储的仓库路径。将其用作 repositoryId 列出分支前，请进行 URL 编码。请求不接受此字段。
provider	object	是	展开字段 字段 类型 必填 说明 provider.id string 是 provider.name string 是 provider.type string 是 可选值：git, gitlab provider.authType string 是 可选值：ssh-key, token provider.createdAt string 是 provider.updatedAt string 是
createdAt	string	是
updatedAt	string	是
direction	string	是	可选值：promote
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.baseBranchName string 是 settings.createBranchOnPromotion boolean 是
checkout	object	是	展开字段 字段 类型 必填 说明 checkout.hasCheckout boolean 是 checkout.matchesEnvironment boolean 是

下载完整 OpenAPI 定义（JSON）

获取晋升环境

返回环境及其提供方摘要和本地检出状态。

GET/promotions/environments/{promotionEnvironmentId}

请求参数

参数	位置	类型	必填	说明
promotionEnvironmentId	path	string	是	晋升环境的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。
503	所请求的服务暂时不可用。

响应结构：200 · application/json

结构 1

字段	类型	必填	说明
id	string	是
name	string	是
scope	string	是	可选值：instance, projects
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是 remote.repositoryPath string 否 Git 主机远程地址所存储的仓库路径。将其用作 repositoryId 列出分支前，请进行 URL 编码。请求不接受此字段。
provider	object	是	展开字段 字段 类型 必填 说明 provider.id string 是 provider.name string 是 provider.type string 是 可选值：git, gitlab provider.authType string 是 可选值：ssh-key, token provider.createdAt string 是 provider.updatedAt string 是
createdAt	string	是
updatedAt	string	是
direction	string	是	可选值：apply
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.branchName string 是
checkout	object	是	展开字段 字段 类型 必填 说明 checkout.hasCheckout boolean 是 checkout.matchesEnvironment boolean 是

结构 2

字段	类型	必填	说明
id	string	是
name	string	是
scope	string	是	可选值：instance, projects
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是 remote.repositoryPath string 否 Git 主机远程地址所存储的仓库路径。将其用作 repositoryId 列出分支前，请进行 URL 编码。请求不接受此字段。
provider	object	是	展开字段 字段 类型 必填 说明 provider.id string 是 provider.name string 是 provider.type string 是 可选值：git, gitlab provider.authType string 是 可选值：ssh-key, token provider.createdAt string 是 provider.updatedAt string 是
createdAt	string	是
updatedAt	string	是
direction	string	是	可选值：promote
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.baseBranchName string 是 settings.createBranchOnPromotion boolean 是
checkout	object	是	展开字段 字段 类型 必填 说明 checkout.hasCheckout boolean 是 checkout.matchesEnvironment boolean 是

下载完整 OpenAPI 定义（JSON）

更新晋升环境

更新名称、提供方、远程地址或设置。远程地址会整体替换已保存的远程配置，设置也会整体替换已保存设置。设置必须与环境方向匹配，因此 Promote 始终要求 `createBranchOnPromotion`。GitLab 环境存储仓库路径，并根据提供方推导 remoteUrl；普通 Git 环境保留完整远程 URL。更新期间提供方发生变化时，返回 409，请重新加载环境后重试。方向和作用域不能更改。

PUT/promotions/environments/{promotionEnvironmentId}

请求参数

参数	位置	类型	必填	说明
promotionEnvironmentId	path	string	是	晋升环境的 ID。

请求体

application/json

字段	类型	必填	说明
name	string	否
providerId	string	否
remote	object	否	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是
settings	联合类型	否	展开字段 结构 1 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.branchName string 是 结构 2 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.baseBranchName string 是 settings.createBranchOnPromotion boolean 是

响应

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

响应结构：200 · application/json

结构 1

字段	类型	必填	说明
id	string	是
name	string	是
scope	string	是	可选值：instance, projects
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是 remote.repositoryPath string 否 Git 主机远程地址所存储的仓库路径。将其用作 repositoryId 列出分支前，请进行 URL 编码。请求不接受此字段。
provider	object	是	展开字段 字段 类型 必填 说明 provider.id string 是 provider.name string 是 provider.type string 是 可选值：git, gitlab provider.authType string 是 可选值：ssh-key, token provider.createdAt string 是 provider.updatedAt string 是
createdAt	string	是
updatedAt	string	是
direction	string	是	可选值：apply
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.branchName string 是
checkout	object	是	展开字段 字段 类型 必填 说明 checkout.hasCheckout boolean 是 checkout.matchesEnvironment boolean 是

结构 2

字段	类型	必填	说明
id	string	是
name	string	是
scope	string	是	可选值：instance, projects
remote	object	是	展开字段 字段 类型 必填 说明 remote.schemaVersion number 是 可选值：1 remote.remoteUrl string 是 remote.repositoryPath string 否 Git 主机远程地址所存储的仓库路径。将其用作 repositoryId 列出分支前，请进行 URL 编码。请求不接受此字段。
provider	object	是	展开字段 字段 类型 必填 说明 provider.id string 是 provider.name string 是 provider.type string 是 可选值：git, gitlab provider.authType string 是 可选值：ssh-key, token provider.createdAt string 是 provider.updatedAt string 是
createdAt	string	是
updatedAt	string	是
direction	string	是	可选值：promote
settings	object	是	展开字段 字段 类型 必填 说明 settings.schemaVersion number 是 可选值：1 settings.baseBranchName string 是 settings.createBranchOnPromotion boolean 是
checkout	object	是	展开字段 字段 类型 必填 说明 checkout.hasCheckout boolean 是 checkout.matchesEnvironment boolean 是

下载完整 OpenAPI 定义（JSON）

删除晋升环境

删除环境及其项目关联和本地检出，保留提供方，不更改 Git 中的任何内容。

DELETE/promotions/environments/{promotionEnvironmentId}

请求参数

参数	位置	类型	必填	说明
promotionEnvironmentId	path	string	是	晋升环境的 ID。

响应

状态码	说明
204	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。
503	所请求的服务暂时不可用。

下载完整 OpenAPI 定义（JSON）

连接环境

在处理请求的实例上准备环境。对于 Git 提供方，会将配置的分支克隆到本地存储。可以安全地重复调用。连接一个环境不会使其他环境也准备就绪。

POST/promotions/environments/{promotionEnvironmentId}/connect

请求参数

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

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
422	无法处理的实体
503	所请求的服务暂时不可用。

响应结构：200 · application/json

字段	类型	必填	说明
environmentId	string	是
direction	string	是	可选值：apply, promote
branchName	string	是
hasCheckout	boolean	是

下载完整 OpenAPI 定义（JSON）

移除环境的本地检出

移除本地检出，保留环境、凭据和受信任的 SSH 主机密钥。

POST/promotions/environments/{promotionEnvironmentId}/disconnect

请求参数

参数	位置	类型	必填	说明
promotionEnvironmentId	path	string	是	晋升环境的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。
503	所请求的服务暂时不可用。

响应结构：200 · application/json

字段	类型	必填	说明
environmentId	string	是
direction	string	是	可选值：apply, promote
branchName	string	是
hasCheckout	boolean	是

下载完整 OpenAPI 定义（JSON）

GET /promotions/environments/{promotionEnvironmentId}/projects（列出关联项目）

列出关联到晋升环境的项目

GET/promotions/environments/{promotionEnvironmentId}/projects

请求参数

参数	位置	类型	必填	说明
promotionEnvironmentId	path	string	是	晋升环境的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。
503	所请求的服务暂时不可用。

响应结构：200 · application/json

字段	类型	必填	说明
projectIds	array	是

下载完整 OpenAPI 定义（JSON）

将项目关联到晋升环境

将团队项目关联到项目作用域的环境。项目的每个方向可以有一个环境；没有项目环境的方向使用实例环境。

POST/promotions/environments/{promotionEnvironmentId}/projects/{projectId}

请求参数

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

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
422	无法处理的实体
503	所请求的服务暂时不可用。

响应结构：200 · application/json

字段	类型	必填	说明
projectId	string	是
environmentId	string	是

下载完整 OpenAPI 定义（JSON）

DELETE /promotions/environments/{promotionEnvironmentId}/projects/{projectId}（解除项目关联）

解除项目与晋升环境的关联

DELETE/promotions/environments/{promotionEnvironmentId}/projects/{projectId}

请求参数

参数	位置	类型	必填	说明
promotionEnvironmentId	path	string	是	晋升环境的 ID。
projectId	path	string	是	项目的 ID。

响应

状态码	说明
204	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
503	所请求的服务暂时不可用。

下载完整 OpenAPI 定义（JSON）

晋升所有团队项目

导出所有团队项目、提交并推送到配置的基础分支或新建的时间戳分支。响应通过 `git.branchName` 报告目标分支，个人项目会被忽略。如果分支上的工作流已移到个人项目，会以 400 拒绝，因为目标端会将其删除。如果分支上的工作流或文件夹已移到其他团队项目，且原项目仍存在，也会以 400 拒绝，因为 Apply 无法将它们跨项目移动。需要已连接且具有实例作用域的 Promote 环境。工作流引用变量时，API 密钥还需具备 variable:list。

POST/promotions/environments/{promotionEnvironmentId}/promote

请求参数

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

请求体

application/json

字段	类型	必填	说明
commitMessage	string	否	晋升提交的消息；省略时使用自动生成的消息。
force	boolean	否

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
environmentId	string	是
counts	object	是	展开字段 字段 类型 必填 说明 counts.workflows integer 是 counts.folders integer 是 counts.credentials integer 是 counts.dataTables integer 是 counts.variables integer 是 counts.tags integer 是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
review	object	否	展开字段 字段 类型 必填 说明 review.reviewId string 是 review.number integer 是 review.webUrl string 是
warnings	array	否	展开字段 字段 类型 必填 说明 warnings.[]message string 是 warnings.[]linkUrl string 否

下载完整 OpenAPI 定义（JSON）

将包应用到实例

检查配置分支最新提交上的完整包。可选地发送 expectedSource，包含已审核变更预览中的 environmentId、branchName 和完整 commitSha；状态 `source-changed` 表示分支在审核后发生变化，没有导入任何内容。需要设置绑定，或此次应用会删除包未包含的团队项目时，在导入写入前返回 `blocked`。保留 environmentId 和 git，供 Continue 使用。状态 `applied` 包含数量统计和警告，应先检查状态，再读取数量。目标现有变量值（包括空字符串）保持不变。工作流和文件夹会在各自项目内移动，以匹配分支，文件夹名称也会采用分支上的名称；如果分支和实例将同一工作流或文件夹归于不同项目，则在任何写入前以 409 拒绝。需要已连接且具有实例作用域的 Apply 环境。API 密钥需要 gitConnection:pull 作用域。导入器会检查用户写入权限，不会收到细粒度的 API 密钥写入作用域。

POST/promotions/environments/{promotionEnvironmentId}/apply

请求参数

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

请求体

application/json

字段	类型	必填	说明
expectedSource	object	否	展开字段 字段 类型 必填 说明 expectedSource.environmentId string 是 expectedSource.branchName string 是 expectedSource.commitSha string 是

响应

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

响应结构：200 · application/json

结构 1

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：applied
counts	object	是	展开字段 字段 类型 必填 说明 counts.projects object 是 展开字段 字段 类型 必填 说明 counts.projects.created integer 是 counts.projects.updated integer 是 counts.projects.skipped integer 是 counts.projects.deleted integer 是 counts.folders object 是 展开字段 字段 类型 必填 说明 counts.folders.created integer 是 counts.folders.updated integer 是 Apply 为匹配分支而移动或重命名的现有文件夹。 counts.folders.skipped integer 是 counts.folders.moved integer 是 Apply 将其移到项目内其他父文件夹下的已更新文件夹，也包含在 updated 中。 counts.folders.renamed integer 是 Apply 将其名称改为分支上名称的已更新文件夹，也包含在 updated 中。 counts.folders.removed integer 是 counts.workflows object 是 展开字段 字段 类型 必填 说明 counts.workflows.created integer 是 counts.workflows.updated integer 是 counts.workflows.skipped integer 是 counts.workflows.moved integer 是 Apply 同时将其移到项目内其他文件夹的已更新工作流，也包含在 updated 中。 counts.workflows.archived integer 是 counts.workflows.deleted integer 是 counts.workflows.publishing object 是 counts.credentials object 是 展开字段 字段 类型 必填 说明 counts.credentials.matched integer 是 counts.credentials.stubbed integer 是 counts.credentials.updated integer 是 counts.dataTables object 是 展开字段 字段 类型 必填 说明 counts.dataTables.matched integer 是 counts.dataTables.created integer 是 counts.dataTables.updated integer 是 counts.variables object 是 展开字段 字段 类型 必填 说明 counts.variables.matched integer 是 counts.variables.created integer 是 counts.variables.updated integer 是 counts.variables.stubbed integer 是 counts.variables.missing integer 是 counts.tags object 是 展开字段 字段 类型 必填 说明 counts.tags.matched integer 是 counts.tags.created integer 是 counts.tags.renamed integer 是 counts.tags.reconciled integer 是 counts.tags.skipped integer 是
warnings	array	是	展开字段 字段 类型 必填 说明 warnings.[]kind string 是 可选值：variable warnings.[]code string 是 可选值：variable-shadowed warnings.[]name string 是 warnings.[]scope object 是 warnings.[]consumers array 是

结构 2

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：blocked
preflight	object	是	展开字段 字段 类型 必填 说明 preflight.missingProjects array 是 包中存在、但实例上不存在的项目。预检会保留其元数据，不检查项目创建规则。项目创建 API 可能拒绝无效值。 preflight.missingBindings array 是 preflight.accessRequirements array 是 preflight.conflicts array 是 preflight.warnings array 是

结构 3

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：source-changed

下载完整 OpenAPI 定义（JSON）

设置绑定后继续 Apply

重新检查配置的源和当前目标绑定。发送 expectedSource，包含已审核 Apply 结果中的 environmentId、branchName 和完整 commitSha。发送 `confirmDestructiveChanges: true`，还会应用破坏性数据表变更，并删除报告的团队项目。状态 `source-changed` 要求重新进行 Apply 审核；`blocked` 返回最新绑定详情，不进行导入写入；`applied` 包含数量统计和警告，应先检查状态，再读取数量。目标现有变量值保持不变。需要与 Apply 相同的已连接实例环境和权限。导入器会检查用户写入权限，不会收到细粒度的 API 密钥写入作用域。不提供服务器会话，也不保证恰好执行一次。

POST/promotions/environments/{promotionEnvironmentId}/apply/continue

请求参数

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

请求体

application/json

字段	类型	必填	说明
expectedSource	object	是	展开字段 字段 类型 必填 说明 expectedSource.environmentId string 是 expectedSource.branchName string 是 expectedSource.commitSha string 是
confirmDestructiveChanges	boolean	否	还会应用 destructive-change 冲突报告的破坏性数据表变更，即移除列或更改列类型。这些列中的值会被移除，行和其他列保留。完整应用时，还会删除 project-deletion 冲突报告的团队项目及其中全部内容。确认覆盖 Continue 运行时所有此类变更和删除，包括未出现在已审核结果中的变更和删除。

响应

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

响应结构：200 · application/json

结构 1

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：applied
counts	object	是	展开字段 字段 类型 必填 说明 counts.projects object 是 展开字段 字段 类型 必填 说明 counts.projects.created integer 是 counts.projects.updated integer 是 counts.projects.skipped integer 是 counts.projects.deleted integer 是 counts.folders object 是 展开字段 字段 类型 必填 说明 counts.folders.created integer 是 counts.folders.updated integer 是 Apply 为匹配分支而移动或重命名的现有文件夹。 counts.folders.skipped integer 是 counts.folders.moved integer 是 Apply 将其移到项目内其他父文件夹下的已更新文件夹，也包含在 updated 中。 counts.folders.renamed integer 是 Apply 将其名称改为分支上名称的已更新文件夹，也包含在 updated 中。 counts.folders.removed integer 是 counts.workflows object 是 展开字段 字段 类型 必填 说明 counts.workflows.created integer 是 counts.workflows.updated integer 是 counts.workflows.skipped integer 是 counts.workflows.moved integer 是 Apply 同时将其移到项目内其他文件夹的已更新工作流，也包含在 updated 中。 counts.workflows.archived integer 是 counts.workflows.deleted integer 是 counts.workflows.publishing object 是 counts.credentials object 是 展开字段 字段 类型 必填 说明 counts.credentials.matched integer 是 counts.credentials.stubbed integer 是 counts.credentials.updated integer 是 counts.dataTables object 是 展开字段 字段 类型 必填 说明 counts.dataTables.matched integer 是 counts.dataTables.created integer 是 counts.dataTables.updated integer 是 counts.variables object 是 展开字段 字段 类型 必填 说明 counts.variables.matched integer 是 counts.variables.created integer 是 counts.variables.updated integer 是 counts.variables.stubbed integer 是 counts.variables.missing integer 是 counts.tags object 是 展开字段 字段 类型 必填 说明 counts.tags.matched integer 是 counts.tags.created integer 是 counts.tags.renamed integer 是 counts.tags.reconciled integer 是 counts.tags.skipped integer 是
warnings	array	是	展开字段 字段 类型 必填 说明 warnings.[]kind string 是 可选值：variable warnings.[]code string 是 可选值：variable-shadowed warnings.[]name string 是 warnings.[]scope object 是 warnings.[]consumers array 是

结构 2

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：blocked
preflight	object	是	展开字段 字段 类型 必填 说明 preflight.missingProjects array 是 包中存在、但实例上不存在的项目。预检会保留其元数据，不检查项目创建规则。项目创建 API 可能拒绝无效值。 preflight.missingBindings array 是 preflight.accessRequirements array 是 preflight.conflicts array 是 preflight.warnings array 是

结构 3

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：source-changed

下载完整 OpenAPI 定义（JSON）

列出项目在某个方向上的变更

比较实例上的团队项目与该方向晋升环境的分支，列出不同的工作流。对于 `promote`，各行表示晋升将发送到分支的内容，密钥需要 gitConnection:push 作用域。`deleted` 或 `new` 的晋升行可能表示跨项目移动的工作流，在移回之前会拒绝晋升。对于 `apply`，各行表示将分支应用到此实例所产生的变更，密钥需要 gitConnection:pull 作用域。`commitSha` 是读取这些行时使用的提交。需要先连接环境。

GET/promotions/projects/{projectId}/changes/{direction}

请求参数

参数	位置	类型	必填	说明
projectId	path	string	是	项目的 ID。
direction	path	string	是	晋升方向：apply 或 promote。 可选值：apply, promote
search	query	string	否
sort	query	string	否	默认值："name" 可选值：name, updatedAt, status
order	query	string	否	默认值："asc" 可选值：asc, desc

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
commitSha	string	是
source	object	是	展开字段 字段 类型 必填 说明 source.environmentId string 是 source.branchName string 是
changes	array	是	展开字段 字段 类型 必填 说明 changes.[]id string 是 changes.[]name string 是 changes.[]type string 是 可选值：workflow changes.[]status string 是 可选值：new, modified, renamed, renamed-and-modified, archived, deleted changes.[]version integer 是 changes.[]updatedAt string 是 changes.[]updatedBy string 是 changes.[]dependencyCount integer 是

下载完整 OpenAPI 定义（JSON）

晋升项目中所选工作流

将团队项目所选工作流晋升到项目 Promote 环境的分支。只发送工作流 id，服务器会即时读取每个工作流，因此推送携带当前状态。项目拥有的未归档和已归档工作流都会导出，已归档 id 在分支上仍保持归档；工作流已从实例消失的 id 会从分支移除，与项目变更列表一致。分支写入后移入或移出此项目的工作流会以 400 拒绝，请先移回。要删除的工作流如果不在分支的此项目下，会在任何写入前拒绝整个请求。需要为项目解析到 Promote 环境，优先使用项目自己的 Promote 环境，否则使用实例 Promote 环境，并且必须先连接。工作流引用变量时，API 密钥还需具备 variable:list。

POST/promotions/projects/{projectId}/promote

请求参数

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

请求体

application/json

字段	类型	必填	说明
workflowIds	array	是
commitMessage	string	否	晋升提交的消息；省略时使用自动生成的消息。

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
environmentId	string	是
counts	object	是	展开字段 字段 类型 必填 说明 counts.workflows integer 是 counts.folders integer 是 counts.credentials integer 是 counts.dataTables integer 是 counts.variables integer 是 counts.tags integer 是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
review	object	否	展开字段 字段 类型 必填 说明 review.reviewId string 是 review.number integer 是 review.webUrl string 是
warnings	array	否	展开字段 字段 类型 必填 说明 warnings.[]message string 是 warnings.[]linkUrl string 否

下载完整 OpenAPI 定义（JSON）

应用项目中所选工作流

从项目的 Apply 分支应用选定工作流变更。通过 workflowIds 发送所选变更列表 ID。服务器会导入分支上属于此项目的所选 ID；对于所选 ID，如果实例中的对应工作流归此项目所有、但分支没有该 ID，则移除该工作流。重复或无效 ID 会拒绝整个请求，未选择的内容保持不变。所选工作流连同其所在文件夹一起在项目内移动，以匹配分支，相关文件夹也采用分支上的名称，其他文件夹保持原样。如果所选工作流，或分支上属于此项目的某文件夹，在分支和实例中归于不同项目，则在任何写入前以 409 拒绝。可选地发送 expectedSource，包含已审核变更预览中的 environmentId、branchName 和完整 commitSha。状态 `source-changed` 表示源在审核后发生变化，没有导入任何内容；选择项需要设置绑定时，`blocked` 会在导入写入前返回绑定详情。保留 environmentId 和 git，供 Continue 使用。状态 `applied` 包含数量统计和警告，应先检查状态，再读取数量。需要项目对应的已连接 Apply 环境，优先使用项目自己的 Apply 环境，否则使用实例 Apply 环境。API 密钥需要 gitConnection:pull 作用域。导入器会检查用户写入权限。

POST/promotions/projects/{projectId}/apply

请求参数

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

请求体

application/json

字段	类型	必填	说明
workflowIds	array	是
expectedSource	object	否	展开字段 字段 类型 必填 说明 expectedSource.environmentId string 是 expectedSource.branchName string 是 expectedSource.commitSha string 是

响应

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

响应结构：200 · application/json

结构 1

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：applied
counts	object	是	展开字段 字段 类型 必填 说明 counts.projects object 是 展开字段 字段 类型 必填 说明 counts.projects.created integer 是 counts.projects.updated integer 是 counts.projects.skipped integer 是 counts.projects.deleted integer 是 counts.folders object 是 展开字段 字段 类型 必填 说明 counts.folders.created integer 是 counts.folders.updated integer 是 Apply 为匹配分支而移动或重命名的现有文件夹。 counts.folders.skipped integer 是 counts.folders.moved integer 是 Apply 将其移到项目内其他父文件夹下的已更新文件夹，也包含在 updated 中。 counts.folders.renamed integer 是 Apply 将其名称改为分支上名称的已更新文件夹，也包含在 updated 中。 counts.folders.removed integer 是 counts.workflows object 是 展开字段 字段 类型 必填 说明 counts.workflows.created integer 是 counts.workflows.updated integer 是 counts.workflows.skipped integer 是 counts.workflows.moved integer 是 Apply 同时将其移到项目内其他文件夹的已更新工作流，也包含在 updated 中。 counts.workflows.archived integer 是 counts.workflows.deleted integer 是 counts.workflows.publishing object 是 counts.credentials object 是 展开字段 字段 类型 必填 说明 counts.credentials.matched integer 是 counts.credentials.stubbed integer 是 counts.credentials.updated integer 是 counts.dataTables object 是 展开字段 字段 类型 必填 说明 counts.dataTables.matched integer 是 counts.dataTables.created integer 是 counts.dataTables.updated integer 是 counts.variables object 是 展开字段 字段 类型 必填 说明 counts.variables.matched integer 是 counts.variables.created integer 是 counts.variables.updated integer 是 counts.variables.stubbed integer 是 counts.variables.missing integer 是 counts.tags object 是 展开字段 字段 类型 必填 说明 counts.tags.matched integer 是 counts.tags.created integer 是 counts.tags.renamed integer 是 counts.tags.reconciled integer 是 counts.tags.skipped integer 是
warnings	array	是	展开字段 字段 类型 必填 说明 warnings.[]kind string 是 可选值：variable warnings.[]code string 是 可选值：variable-shadowed warnings.[]name string 是 warnings.[]scope object 是 warnings.[]consumers array 是

结构 2

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：blocked
preflight	object	是	展开字段 字段 类型 必填 说明 preflight.missingProjects array 是 包中存在、但实例上不存在的项目。预检会保留其元数据，不检查项目创建规则。项目创建 API 可能拒绝无效值。 preflight.missingBindings array 是 preflight.accessRequirements array 是 preflight.conflicts array 是 preflight.warnings array 是

结构 3

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：source-changed

下载完整 OpenAPI 定义（JSON）

设置绑定后继续应用所选工作流

重新检查项目的 Apply 源，以及选择项当前的绑定。通过 workflowIds 重新发送完整选择列表。必须发送 expectedSource，包含已审核 Apply 结果中的 environmentId、branchName 和完整 commitSha。发送 `confirmDestructiveChanges: true`，还会应用破坏性数据表变更。服务器不保留会话。状态 `source-changed` 要求重新进行 Apply 审核；`blocked` 会在导入写入前返回最新绑定详情；`applied` 包含数量统计和警告，应先检查状态，再读取数量。未选择的内容保持不变。需要与初次应用所选工作流相同的已连接 Apply 环境和权限。API 密钥需要 gitConnection:pull 作用域。导入器会检查用户写入权限。

POST/promotions/projects/{projectId}/apply/continue

请求参数

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

请求体

application/json

字段	类型	必填	说明
workflowIds	array	是
expectedSource	object	是	展开字段 字段 类型 必填 说明 expectedSource.environmentId string 是 expectedSource.branchName string 是 expectedSource.commitSha string 是
confirmDestructiveChanges	boolean	否	还会应用 destructive-change 冲突报告的破坏性数据表变更，即移除列或更改列类型。这些列中的值会被移除，行和其他列保留。完整应用时，还会删除 project-deletion 冲突报告的团队项目及其中全部内容。确认覆盖 Continue 运行时所有此类变更和删除，包括未出现在已审核结果中的变更和删除。

响应

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

响应结构：200 · application/json

结构 1

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：applied
counts	object	是	展开字段 字段 类型 必填 说明 counts.projects object 是 展开字段 字段 类型 必填 说明 counts.projects.created integer 是 counts.projects.updated integer 是 counts.projects.skipped integer 是 counts.projects.deleted integer 是 counts.folders object 是 展开字段 字段 类型 必填 说明 counts.folders.created integer 是 counts.folders.updated integer 是 Apply 为匹配分支而移动或重命名的现有文件夹。 counts.folders.skipped integer 是 counts.folders.moved integer 是 Apply 将其移到项目内其他父文件夹下的已更新文件夹，也包含在 updated 中。 counts.folders.renamed integer 是 Apply 将其名称改为分支上名称的已更新文件夹，也包含在 updated 中。 counts.folders.removed integer 是 counts.workflows object 是 展开字段 字段 类型 必填 说明 counts.workflows.created integer 是 counts.workflows.updated integer 是 counts.workflows.skipped integer 是 counts.workflows.moved integer 是 Apply 同时将其移到项目内其他文件夹的已更新工作流，也包含在 updated 中。 counts.workflows.archived integer 是 counts.workflows.deleted integer 是 counts.workflows.publishing object 是 counts.credentials object 是 展开字段 字段 类型 必填 说明 counts.credentials.matched integer 是 counts.credentials.stubbed integer 是 counts.credentials.updated integer 是 counts.dataTables object 是 展开字段 字段 类型 必填 说明 counts.dataTables.matched integer 是 counts.dataTables.created integer 是 counts.dataTables.updated integer 是 counts.variables object 是 展开字段 字段 类型 必填 说明 counts.variables.matched integer 是 counts.variables.created integer 是 counts.variables.updated integer 是 counts.variables.stubbed integer 是 counts.variables.missing integer 是 counts.tags object 是 展开字段 字段 类型 必填 说明 counts.tags.matched integer 是 counts.tags.created integer 是 counts.tags.renamed integer 是 counts.tags.reconciled integer 是 counts.tags.skipped integer 是
warnings	array	是	展开字段 字段 类型 必填 说明 warnings.[]kind string 是 可选值：variable warnings.[]code string 是 可选值：variable-shadowed warnings.[]name string 是 warnings.[]scope object 是 warnings.[]consumers array 是

结构 2

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：blocked
preflight	object	是	展开字段 字段 类型 必填 说明 preflight.missingProjects array 是 包中存在、但实例上不存在的项目。预检会保留其元数据，不检查项目创建规则。项目创建 API 可能拒绝无效值。 preflight.missingBindings array 是 preflight.accessRequirements array 是 preflight.conflicts array 是 preflight.warnings array 是

结构 3

字段	类型	必填	说明
environmentId	string	是
git	object	是	展开字段 字段 类型 必填 说明 git.commitSha string 是 git.branchName string 是
status	string	是	可选值：source-changed

下载完整 OpenAPI 定义（JSON）