git.branches.create

Create a branch from a ref

POST /git/api/repositories/{repoId}/branchesIAM git:PushRepositoryChanges stateDestructive

Writing through the console is the same act as pushing, so every write route needs git:PushRepository.

Request syntax

POST /git/api/repositories/{repoId}/branches
{
  "name": "string",
  "from": "string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Request body

  • nameRequired

    string

    The new branch

    Constraints: 1-255 chars

  • fromRequired

    string

    The branch, tag or commit id it starts at

    Constraints: 1-255 chars

Response

200 with the new branch `name` and the `oid` it points at. 409 when it is refused (it exists, the ref is unknown, or a protection rule says no).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • nameAlways

    string

    The new branch
  • oidAlways

    string

    The commit id it points at

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:PushRepository on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git branches create repoId --name example --from example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_branches_create.