Rename branch
PATCHhttps://api.instacloud.com/projects/{projectId}/branches/{branchId}
Token scope: account · org · project — read-only tokens refused (not a GET).
Rename a branch (metadata only; not the default). Provider resources keep their original names.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
projectId | path | string | yes | |
branchId | path | string | yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | lower-kebab: a-z, 0-9, hyphen |
Responses
200
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
branch | object | no | |
branch.id | string | no | |
branch.project_id | string | no | |
branch.name | string | no | |
branch.parent_branch_id | string | null | no | |
branch.is_default | boolean | no | |
branch.status | "creating" | "active" | "error" | "deleting" | no | |
branch.created_at | string | no |
202
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
status | string | yes | |
approvalId | string | yes | |
action | string | yes | |
actions | string[] | yes | |
message | string | yes | |
url | string | yes |
400
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |
404
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |
409
Default Response
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |