CreateBranch - 创建分支
创建 Supabase 项目分支。
接口说明
该接口用于基于指定父分支创建一个新的 Supabase 分支。创建子分支时默认继承主分支的地域、网络、存储等资源配置。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。创建主分支时必须指定，创建子分支时默认继承主分支所在地域。 |
cn-beijing |
| ProjectId |
string |
是 |
主分支对应的 Supabase 项目 ID。 |
spb-xxxx |
| ParentBranchId |
string |
是 |
父分支 ID，用于指定新分支或查询条件的上级分支。 |
br-main |
| BranchName |
string |
是 |
分支名称。 |
dev |
| Description |
string |
否 |
分支描述信息。 |
test branch |
| Tag |
array<object> |
否 |
分支标签列表。 |
|
|
object |
否 |
标签对象，包含标签键和标签值。 |
||
| Key |
string |
否 |
标签键。 |
env |
| Value |
string |
否 |
标签值。 |
dev |
| InitSource |
string |
否 |
分支初始化来源。 取值：
|
ParentData |
| ParentTimestamp |
string |
否 |
从父分支创建分支时选择的数据同步时间点，格式为 ISO 8601 UTC 时间。 默认值：当前时间。 |
2026-04-08T09:11:12Z |
| ParentLsn |
string |
否 |
从父分支创建分支时选择的 LSN。 |
0/3522648 |
| Protected |
boolean |
否 |
是否开启分支保护。 取值：
|
false |
| ExpiresAt |
string |
否 |
分支过期自动删除时间，格式为 ISO 8601 UTC 时间。 |
2026-10-08T09:11:12Z |
| ClientToken |
string |
否 |
客户端幂等令牌，用于保证重试请求的幂等性。 |
123e4567-e89b-12d3-a456-426614174000 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
ABB39CC3-4488-4857-905D-2E4A051D**** |
| BranchId |
string |
分支 ID，用于唯一标识一个 Supabase 分支。 |
br-xxxx |
| ProjectId |
string |
主分支对应的 Supabase 项目 ID。 |
spb-xxxx |
示例
正常返回示例
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****",
"BranchId": "br-xxxx",
"ProjectId": "spb-xxxx"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。